Installation

Install the Chargebee CLI for your environment, upgrade an existing installation, or remove it from your machine.

Install the Chargebee CLI

The macOS, Linux, and Windows installers provide a standalone binary without a Node.js dependency.

Install the CLI on macOS or Linux

curl -fsSL https://raw.githubusercontent.com/chargebee/cli/main/install.sh | bash

Install the CLI on Windows with PowerShell

irm https://raw.githubusercontent.com/chargebee/cli/main/install.ps1 | iex

Install the CLI with npm

Install Node.js 22.12.0 or later before using npm.

npm install --ignore-scripts -g @chargebee/cli

Verify the installation:

chargebee --help

After installation, connect the CLI to a Chargebee site and run your first command.

Upgrade the Chargebee CLI

chargebee update

Updates the npm package or standalone binary, depending on how you installed the CLI.

Uninstall the Chargebee CLI

To remove saved profiles and credentials, run chargebee auth remove <profile> for each profile. If credential cleanup fails, remove the remaining key from your OS credential manager. Then delete the configuration directory:

rm -rf ~/.chargebee/cli

Remove the CLI the same way you installed it:

npm uninstall -g @chargebee/cli     # npm
rm "$(command -v chargebee)"        # macOS / Linux installer

Remove-Item (Get-Command chargebee).Source    # Windows installer