Configuring the command-line interface

You must configure the command-line interface to run your commands securely. After you extract the command-line interface tool, you can run the ssctl --help command to get the information about the available commands.

For example, to use the command-line interface, you might need an API token. You can provide the API token by using the command-line parameters or you can add the API token in a configuration file, which can be used across all the commands.

You can select the method to run the command and automate the task. For example, you want to run a script that sometimes deploys the customization in your development environment and at other times, in your QA environment. You can use an environment variable that controls your selected environment. You can then use this environment variable by using the command-line parameter.

Alternatively, if you want to use the configuration file, you can use the command-line interface to create a template and then provide the required information in that template. Use the following command to run the command-line interface.

ssctl config create -f myconfig.json

A myconfig.json file is created in your current directory. Open this file in an editor and provide the missing values. You can provide the token, tenantCode, and environmentName values.

You can override these values at any time by setting a command-line parameter.