CLI Command Reference ​

Learn more about the commands you can use in CLI after installing the SDK gem.

workato ​

Root command of the Workato gem. Synonymous with workato help.

Usage ​

$ workato

Output ​

Description of commands available in the Workato gem.

workato edit ​

Creates or edits an encrypted file.

Usage ​

$ workato edit <PATH>

Input ​

Options ​

Result ​

Encrypted file is created or updated. master.key is created if the file didn't previously exist and an option wasn't provided.

Example ​

For Windows:
  $ set EDITOR=notepad
  $ workato edit settings.yaml.enc
For Mac:
  $ EDITOR="nano" workato edit settings.yaml.enc

workato exec ​

Executes a specific lambda function in your connector for testing.

Usage ​

$ workato exec <PATH> <OPTIONS>

Input ​

Options ​

Result ​

The output of the lambda function.

Examples ​

Invoke a specific method.

$ workato exec methods.sample_method --args='input/sample_method_input.json'

Invoke the acquire lambda. Connector and settings are all specified.

workato exec connection.authorization.acquire --connector='zoominfo.rb' --settings='settings.yaml' --connection='My Valid Connection' --verbose

Invoke the test lambda. Connector and settings are all specified.

workato exec test --connector='zoominfo.rb' --settings='settings.yaml' --connection='My Valid Connection' --verbose

Invoke a specific action and pass it inputs.

$ workato exec actions.search_customers.execute --input='input/search_customer_input.json' --verbose

Invoke a specific polling trigger and pass it inputs. This command simulates the trigger paginating through a series of records when can_poll_more is set to true in the closure.

$ workato exec triggers.new_updated_customers.poll --input='input/new_updated_customers_input.json' --verbose

Invoke a specific polling trigger and pass it inputs. Output will be a single page of the poll. This command simulates a single trigger poll and returns only the first page.

$ workato exec triggers.new_updated_customers.poll_page --input='input/new_updated_customers_input.json' --verbose

workato generate ​

Generates Workato schema based on a given JSON or CSV or tests based on a given connector

Usage ​

$ workato generate <SUBCOMMAND>

Input ​

workato generate schema ​

Takes a given JSON or CSV file and converts it into Workato Schema for use in your connector

Usage ​

$ workato generate schema --api-token <API-TOKEN> <OPTIONS>

Options ​

Examples ​

Convert sample JSON payload to Workato schema

$ workato generate schema --api-token --json='fixtures/actions/search_customers/input.json'

Convert sample pipe delimited CSV file to Workato schema with

$ workato generate schema --api-token --csv='fixtures/actions/report/input.csv' --col-sep=pipe

workato generate test ​

Takes a given connector and generates RSpec tests for specified features.

Usage ​

$ workato generate test <OPTIONS>

Options ​

Examples ​

Generate skeletal tests for all connector features

$ workato generate test

Generate skeletal tests for specific action

$ workato generate test action=get_customers

workato help ​

Displays help for a specified SDK gem command.

Usage ​

$ workato help <COMMAND>

Input ​

Output ​

Elaborated help for the specified SDK gem command.

Example ​

$ workato help edit
Usage:
  workato edit PATH

Options:
  -k, [--key=KEY]                  # Path to file with encrypt/decrypt key. NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
      [--verbose], [--no-verbose]

Edit encrypted file, e.g. settings.yaml.enc

workato new ​

Creates a new connector project in your chosen directory.

When you create a new connector project, you will be asked if you want to select secure or simple for your HTTP mocking behavior:

Please select default HTTP mocking behavior suitable for your project?

1 - secure. Cause an error to be raised for any unknown requests, all request recordings are encrypted.
            To record a new cassette you need set VCR_RECORD_MODE environment variable

            Example: VCR_RECORD_MODE=once bundle exec rspec spec/actions/test_action_spec.rb

2 - simple. Record new interaction if it is a new request, requests are stored as plain text and expose secret tokens.

Usage ​

$ workato new <PATH>

Input ​

Result ​

Generates a new connector project.

Example ​

$ workato new ~/Desktop/my-new-connector

workato oauth2 ​

Use this to implement the OAuth2 Authorization code grant flow for applicable connectors. Applicable connectors are ones where the connection hash has `type: 'oauth2`. For more information, check out this handy Okta article.

Usage ​

$ workato oauth2 <OPTIONS>

Options ​

Result ​

Emulates the OAuth2 Authorization Code Grant Flow on Workato. Applicable connectors are ones where the connection hash has `type: 'oauth2`. For more information, check out this handy Okta article.

Example ​

$ workato oauth2

workato push ​

Creates a new connector project in your chosen Workato folder.

Usage ​

$ workato push --api-token <API-TOKEN> <OPTIONS>

Options ​

Example ​

workato push --api-token