Installation
The Contox CLI is distributed as an npm package called contox-cli. It provides the contox binary.
Prerequisites
- Node.js 18+ installed on your machine
- npm, yarn, or pnpm as your package manager
Install globally
Install the CLI globally so the contox command is available system-wide:
bash
npm install -g contox-cli
With yarn:
bash
yarn global add contox-cli
With pnpm:
bash
pnpm add -g contox-cli
Verify the installation
Confirm the CLI is installed and accessible:
bash
contox --version
This prints the installed version number. If you see a "command not found" error, ensure your global npm bin directory is in your system PATH.
Update to the latest version
To update the CLI to the latest release:
bash
npm update -g contox-cli
Or reinstall:
bash
npm install -g contox-cli@latest
First-time setup
After installation, you need to authenticate and initialize your project:
- Log in with your API key:
bash
contox login -k <your-api-key>
- Verify the connection:
bash
contox whoami
- Initialize your project:
bash
contox init -t <team-id> -n "My Project"
See the Quick Start guide for a complete walkthrough.