Installation

Install the Carrier OS CLI globally with npm. Two identical commands are installed: cos (primary) and carrieros.

Beta distribution. During the beta the CLI ships as an npm package. If your account was given a packed tarball instead of public npm access, use the tarball command under Offline / tarball install below.

Requirements

Node.js 18 or newer. Check with node -v.
A Carrier OS secret API key from the Developer Portal (Projects → API keys).

Install

bash

npm install -g @carrieros/cli

Both of these launch the CLI — they are identical:

bash

cos            # primary — opens the interactive shell
carrieros      # full-name alias

Verify the install

bash

cos version

text

Carrier OS CLI 0.1.0
API Version    v1
Endpoint       https://api.carrieros.ai/v1

Offline / tarball install (beta)

If you received a packed tarball, install it exactly as a published package:

bash

npm install -g ./carrieros-cli-0.1.0.tgz

Update

Upgrade to the latest published version at any time:

bash

npm install -g @carrieros/cli@latest

Check what you're running with cos version — it prints the CLI version alongside the API version it is talking to.

Uninstall

bash

npm uninstall -g @carrieros/cli

Next: sign in and open the shell in the Quick Start.