Catalyst provides the following CLI options that you can use with any of the CLI commands:
-v | --version
This option prints the version number of the Catalyst CLI that you are currently using. You can type
--version with the catalyst command in the following way:
-p | --project <name_or_project_id> --org <org_id>
The -p or --project option is used to provide the name or the ID of the Catalyst project the CLI command must be executed for. This option is highly beneficial when you have not initialized or made a project active for your working directory in the CLI. You can also use this option if you are executing Catalyst CLI commands from a remote system, such as a remote code repository or CI system, without an active login session using a token.
You can execute the Catalyst command by directly specifying the project the command is intended for, without having to initialize or enable a project in the CLI. The name or the ID of the project must be mentioned with the option.
You can use the --org option to provide the organization name of the project for which the CLI command must be executed.
For example, to deploy the client component of the EventApp project from the CLI, we execute the following command from the project directory:
The --token option is used to authenticate the execution of a Catalyst CLI command. The Catalyst CLI tokens allow you to execute CLI commands from a remote system, such as a CI tool, without an active user session logged in. You can learn more about Catalyst CLI tokens from the Working with Tokens help page .
You must generate a token when you are logged in to a user account from the CLI. You can then use that token from any remote system to perform all CLI operations without an active login session. This is done by specifying the token as an option following the CLI command. This token acts as an authenticating factor for that user account, and continues to map your command executions to the project you specify.
For example, you can initialize the functions component of a Catalyst project from a remote system to your project directory using the --token option as follows:
This will prompt Catalyst to verify the token, and begin the initialization process if the token is found to be valid.
To read about using CLI tokens in a CI/CD use case, refer to the Implementing CI/CD in Catalyst tutorial.
The --dc<us|eu|in|au> option enables you to execute a command from a specific DC login. Catalyst is currently available in four data centers: US , EU, IN, and AU. You can generally select the data center that you will be accessing Catalyst from while logging in to the CLI.
Catalyst enables you to maintain different logins from each data center simultaneously. That is, you can have one valid token in both data centers each, to authenticate your command executions. You can then choose to execute a command from any one of the data centers, by specifying it using this option.
For example, if you have a valid login in both EU and US DC simultaneously, you can initialize a project and its resources in your directory for the user account associated with the US data center by executing the command in the following way:
This will enable Catalyst to initialize a project, after verifying the credentials in the data center that you specify.
The --verbose option is used to display detailed information about the actions taking place when a CLI command is executed. Information including the details of the HTTP request sent to the server when the command is executed, details of the responses received, details about the CLI environment, the authorization tokens used to contact the server, and the cookies set are displayed.
The --verbose option helps you debug and troubleshoot the CLI command executions and enables you to identify the source of an error. You can execute any CLI command with the --verbose option.
For example, you can projects list command using the verbose option as follows:
-h | --help
The -h or --help option is used to get help with a CLI command. This provides a brief description of the command’s functionality and lists the options that are available for the command and their syntax.
For example, if you require help with the catalyst functions:shell command, you can execute the following command:
You can also get help for the command by executing catalyst help functions:shell .
Last Updated 2023-08-04 20:20:24 +0530 +0530
Send your feedback to us