Generate a Token

Command Execution


  1. You can generate a token for your user account from Catalyst CLI by executing the following command:
copy
$
catalyst token:generate

This will initiate the token generation process. The CLI will display a URL that you can visit from any device. It will also generate a device verification code, which you must enter in the web page of the URL.

catalyst_cli_token_generate


  1. Navigate to the URL displayed in the CLI and enter the verification code. Click Verify . The code will only be valid for five minutes.

catalyst_cli_token_generate_verification


Once your device’s CLI is verified, the token will be generated and displayed in your CLI.

catalyst_cli_token_generated


You can now use this token to perform any CLI operation from any remote device, even when logged out, by specifying it as an option with the CLI command in the following manner:

copy
$
catalyst command --token [token]

To learn more, refer to the CLI options help page

The CLI operation will be mapped to the user account that you generated the token for, and the command will be executed for the account’s project that is active in that directory.


Generate Token Options

You can also use the catalyst token:generate command to check the token that’s currently active in your logged-in session. To do so, execute the command with the option --current in the following way:

copy
$
catalyst token:generate --current

This will display the token that is currently active and authenticated in the CLI.

catalyst_cli_token_generate_current

Note: The catalyst token:generate –current command can only be used when you are logged in to a user account in the CLI.

Last Updated 2023-04-19 15:32:07 +0530 +0530