OneSaas CLI

OneSaas-Cli is a Command Line Interface for developing OneSaas Spokes.

A OneSaas Spoke is an extension of the OneSaas Integration platform that connects a third-party application to the OneSaas Hub.

The OneSaas Hub allows you to build a single integration (the Spoke) into the Hub and integrate with all the other compatible Spokes.

Getting Started

Prepare your environment

1. Create a Developer account at https://sandbox.onesaas.com/developer/register.
2. Install latest node.js for your platform (Windows, Mac, Linux)
3. Open a Command Prompt/Terminal
4. Install the latest OneSaas-Cli by typing npm install -g onesaas-cli

Create your first OneSaas Spoke

1. Create a new folder where your OneSaas Spoke code will reside

2. Initialize the spoke

   onesaas --init

3. Follow the prompts to create your first Spoke. The init wizard will create for you a default Spoke with some default configuration and set of resources.

4. Authorize:

   onesaas --auth

   You will need to provide your registered email and password.

5. Make sure you review the connection.sandbox.json file to update your connection details.

6. Build (and publish) your Spoke:

   onesaas --build watch

   The --build will package, validate and publish your first spoke while the watch will keep monitoring the folder for changes and re-upload them to our servers. If the process is successful, the spoke will be published, and a test account with a prepared connection to your spoke will be created to help you start testing. The url when you can start testing will appear on the screen.

7. Test the connectivity of your spoke by going to the received Url and connecting to your spoke.

8. Continue building your resources and configuration.

Change Log

• Version 1.0.32 - Fixed auth support for node v10
• Version 1.0.31 - Added support v= during when using --build publish
• Version 1.0.30 - Added support for .js files in the ./content folder
• Version 1.0.29 - Added support for .zip files in the ./content folder
• Version 1.0.28 - Improved handling of auth tokens
• Version 1.0.25 - (experimental) Added option to output test results in XUnit2 XML format output=xunit2
• Version 1.0.24 - (experimental) Added GraphQL support
• Version 1.0.23 - Improved default template
• Version 1.0.22 - Improved logging, reporting and the templates
• Version 1.0.20 - Improved the help and errors
• Version 1.0.18 - Added default templates for 3PL/Fulfillment
• Version 1.0.17 - Improved defaults support for json files with comments and improved the --compile command
• Version 1.0.16 - Improved support and reporting for testing spokes
• Version 1.0.15 - Improved support for loading fonts woff, woff2 and ttf

  @font-face {
      font-family: "My Icons";
      src: url(/api/connectiontype/[spokename]/content/[fontname].woff) format("woff"), url(/api/connectiontype/[spokename]/content/[fontname].woff2) format("woff2");
  }

• Version 1.0.14 - Added support for custom fonts in the .\content folder. You can load a custom font from your partner.less file using:

  @font-face {
      font-family: "My Icons";
      src: url(/api/connectiontype/[spokename]/content/[fontname].woff) format("woff");
  }

• Version 1.0.13 - Improved handling of paths when executing commands
• Version 1.0.12 - Bug fixes
• Version 1.0.11 - Version update
• Version 1.0.10 - Added spoke path as an optional first argument, Added -t (--test) command that runs spoke tests.
• Version 1.0.9 - Added support for errorhandlers.json
• Version 1.0.8 - Improved --run command to add support for ts=[HH:mm]|[+/-[3H10M] (timestamp or time span) and a=[accountName] to select an account on which to run the operation
• Version 1.0.7 - Added command --run operation:name resource:name [watch] to manually run a system:retrieve operation on a resource
• Version 1.0.6 - Added support for silent to reduce output and env=[name] to allow commands to change the used environment on the fly
• Version 1.0.5 - Improved --init process and simplified default templates
• Version 1.0.4 - Improved documentation, fixed errors during install
• Version 1.0.3 - Added support for --compile to compile transformations and --build watch to build and watch for changes
• Version 1.0.2 - Added support for --publish
• Version 1.0.1 - Added support to --list & --download existing spokes
• Version 1.0.0 - Initial release. Added support for --init, --auth, --build and --validate