Skip to main content

Commands

Note that all commands have options, and they can be listed by calling integration-cli $COMMAND --help

Default environment

Most commands accept an --environment flag (production, staging, or local). Examples below pass --environment=production explicitly so the command is unambiguous about which Unito platform it targets. Pin your environment on every invocation rather than relying on the default.

activity

Show the activity associated with this connector.

integration-cli activity

dev

Develop your connector using our interactive debugger tool.

integration-cli dev

encrypt

Client secrets and passwords can be encrypted using this command.

integration-cli encrypt --environment=production

init

Initialize a new connector.

integration-cli init

invite

Give access to your connector to other users.

integration-cli invite

login

Authenticate yourself using your API key.

integration-cli login --environment=production

oauth2

Perform an OAuth2 workflow to either populate or refresh a test account's credentials.

integration-cli oauth2 --environment=production

publish

Publish your connector.

integration-cli publish --environment=production

test

Test your connector.

integration-cli test

upgrade

Upgrade the CLI.

integration-cli upgrade

Configuration

By default, the CLI uses the .unito.json file at the root of your connector directory for most of its operations. The information it contains will be used when publishing your connector to our environment or running tests, defining important things like the connector name, the authorization methods, encrypted secrets, test accounts, etc.

You may want to use a different configuration file in some cases, for example if you need to use a different secret value in development vs in production. To that end, you can specify the relative path from the connector's root directory to the file you want to use.

integration-cli publish --live-preview --environment=production --config-path=/my-config.json