tymly-cli

1.0.0 • Public • Published

tymly-cli

JavaScript Style Guide license

CLI tool to launch Tymly State Machines over REST

Install

$ npm install tymly-cli --save

Usage

$ npm run cli --name configName
--name

Name of the configuration you want to run, it must match with a config name. e.g. search, refreshRanking

Each config will have it's own set of input values and must be added as extra flags. For example, if you wish to launch the search state machine you can pass in a query, a limit and an offset so the command will look like the following:

$ npm run cli --name=search --query=kebab --limit=12 --offset=0

To find the input flags, you can look in the run-configurations directory and find the state machine you wish to run.

Build environment variables

Environment Variable Notes Example
TYMLY_API_URL The base URL of Tymly http://localhost:3210
TYMLY_NIC_AUTH0_CLIENT_ID The client ID (as supplied by Auth0) abc...
TYMLY_NIC_AUTH0_CLIENT_SECRET The client secret (as supplied by Auth0) abc...
TYMLY_NIC_AUTH0_DOMAIN The client domain (as supplied by Auth0) abc.de.auth0.com
TYMLY_AUTH_AUDIENCE The Tymly audience abc...

Once the environment variables have been set, you can run the tests like this:

$ npm test

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i tymly-cli

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

8.93 kB

Total Files

12

Last publish

Collaborators

  • meena.hoda