CLI Authentication and Adding Tokens

To start using CLI commands, you must first authenticate yourself after installing the CLI and configuring the region. The Contentstack CLI Authentication feature allows you to securely log in or use tokens—such as Management or Delivery tokens—to perform content management tasks via the terminal.

It supports login credentials, Two-Factor Authentication, and Single Sign-On (SSO). You can authenticate either by using the login command or by adding a Management Token to the local config.

Prerequisites

• Contentstack account
• CLI installed
• Set Region

Commands

Authentication

Login

The auth:login command lets you log in to Contentstack and save the login information in your local storage.

Note: The Contentstack CLI supports Two-factor Authentication for enhanced security.

Open the terminal and run the following command to log in with your Contentstack account credentials. Once you log in, you can use the Contentstack CLI commands such as export, import, clone, bulk publish and unpublish, seed, bootstrap, migration, etc.

Usage

csdx auth:login

OR

csdx login

Options

• -u, --username=username: Email address of your Contentstack account.
• -p, --password=password: Password of your Contentstack account.
• --oauth: Enables Single Sign-On (SSO) for Contentstack CLI.

Examples

csdx auth:login -u youremail@contentstack.com

csdx auth:login -u youremail@contentstack.com -p *****

csdx auth:login --username youremail@contentstack.com --password *****

csdx login -u youremail@contentstack.com

csdx auth:login --oauth

Logout

The auth:logout command lets you log out and clear the authentication from the local storage.

Usage

csdx auth:logout

OR

csdx logout

Options

• -y, --yes: Skips the confirmation prompt and forces the logout process.

Examples

csdx auth:logout -y

csdx logout -y

Display Username of the Logged in User

The csdx auth:whoami command returns the username (email address) of the user who is currently logged in.

Usage

csdx auth:whoami

OR

csdx whoami

Token Management

Add Management Token

Note: Ensure you have already generated a Management Token in your stack before running this command.

The following command lets you add an existing Management Token from your Contentstack account to the local config for further use.

Usage

csdx auth:tokens:add --management

Options

• -a, --alias=alias: Alias (name) you want to assign to the token.
• --management: Flag to save the Management Token.
• -k, --stack-api-key=stack-api-key: API key of the stack where the token exists.
• --token=token: Value of the token.
• -y, --yes: Skips the confirmation and replaces any existing token with the same alias.

Examples

csdx auth:tokens:add --management -a tokenname -k blt******** --token cs*********

csdx auth:tokens:add --management -a tokenname -k blt******** --token cs********* -y

Note: This command does not generate a new token in your stack. It only allows you to use an existing Management Token with the CLI.

Add Delivery Token

Note: Ensure you have already generated a Delivery Token in your stack before running this command.

For CLI commands, you may use a Delivery Token instead of a Management Token. However, Delivery Tokens cannot be used for importing or exporting content.

Usage

csdx auth:tokens:add --delivery

Options

• -a, --alias=alias: Alias (name) you want to assign to the token.
• --delivery: Flag to save the Delivery Token.
• -e, --environment=environment: Environment name for Delivery Token.
• -k, --stack-api-key=stack-api-key: API key of the stack where the token exists.
• --token=token: Value of the token.
• -y, --yes: Skips the confirmation and replaces any existing token with the same alias.

Examples

csdx auth:tokens:add --delivery -a tokenname -k blt******** --token cs*********

csdx auth:tokens:add --delivery -a tokenname -k blt******** --token cs********* -y

Delete Token

Note: This command will not delete the Management/Delivery token from the stack; it deletes the token from the local config.

Usage

csdx auth:tokens:remove

Options

• -a, --alias=alias: Alias (name) of the token to delete.
• -i, --ignore: Ignores if the token is not present.

Examples

csdx auth:tokens:remove -a mytoken

csdx auth:tokens:remove --alias=mytoken

List All Tokens

The auth:tokens command lists all tokens stored in the local config.

Usage

csdx auth:tokens

Options

• -x, --extended: Shows additional columns.
• --columns=columns: Displays specific columns, separated by commas.
• --csv: Outputs data in CSV format.
• --filter=filter: Filters properties using partial string matching (e.g., name=foo).
• --no-header: Hides the table header in the output.
• --no-truncate: Prevents truncation of output to fit the screen.
• --output=csv|json|yaml: Displays output in a particular format.
• --sort=sort: Sorts the list; prefix with ‘-’ for descending order.

Next Steps

• Export and import content
• Publish entries/assets in bulk