Install the CLI

Contentstack CLI can be installed in macOS, Windows and Linux environments. In this guide, you'll learn how to install and update command-line interface (CLI).

Prerequisites

• Contentstack account
• Node.js version 8 or above

Install CLI

To install CLI as a global module in your machine, open your terminal (command prompt) and run this command:

npm install -g @contentstack/cli

Once the CLI is successfully installed, you can use the csdx command from your terminal. 

The csdx is a top-level namespace in Contentstack that gives you access to Contentstack's extensive range of commands and functionalities.

Additional Resource: Visit our CLI GitHub page for more information. You can also read about Contentstack CLI on the npm page.

Next, let’s verify the CLI installation.

Verify installation

Verify your installation by running the csdx --help, in your terminal, to get a list of commands that will help you to interact with Contentstack.

As shown in the above image, the help namespace contains other namespaces within it.
Let’s understand these namespaces in detail.

Namespaces

Namespace is used to categorize commands as per their functionality or purpose.

The following namespaces exist within the csdx command:

• auth: To perform authentication-related activities.
• cm: To perform content management activities such as bulk publish, bulk unpublish, import and export content.
• help: To list useful commands in the CLI.
• plugins: To list the installed plugins.
• config: To work with regions in the CLI.

Note: The guide to create your own plugin within csdx is yet to come. But, as our CLI is built using the oclif package, you can create your custom plugin by referring to oclif plugin documentation.

Here are the commands within each namespace:

• auth
  • csdx auth:login
  • csdx auth:logout
  • csdx auth:tokens
  • csdx auth:whoami
• cm
  • cm:bulk-publish
  • cm:bulk-publish:unpublish
  • cm:export
  • cm:import
• config
  • config:get:region
  • config:set:region

Refer the section below to check the CLI version on your machine and update it to use the latest version.

Check CLI Version

To check the current version of CLI installed on your machine, run this command in the terminal:

csdx --version

Running this command will display the current version, as shown below:

Update CLI Version

As mentioned above, you can check the version of CLI installed on your machine.
To get the latest version of CLI, run the following command in your terminal:

npm install -g @contentstack/cli update

Next Step

• Authenticate with the CLI