Carrier OS CLI

The official command-line client for Carrier OS. It talks directly to the public /v1 API using your API key, and gives developers an interactive AI shell right in the terminal.

The CLI is in beta. Commands, flags, and output shown here reflect the current build; behavior labeled beta may change before general availability.

What it is

A single binary you install globally with npm. Run cos (or the full-name alias carrieros) to launch it.
A thin, typed client over the Public API — it never reimplements platform logic. Every command maps to a /v1 endpoint you could call yourself.
An interactive AI shell as the default experience: type a message to chat, or type / to run commands — sessions, files, usage, models, and diagnostics, all in one place.

How it authenticates

The CLI authenticates exactly like any developer integration: a secret API key (carrier_sk_…) sent as a Bearer token. The key is scoped to a single workspace and project — see Authentication.

The developer workflow

From the Developer Portal to your first answer in the shell:

text

Developer Portal
      │
Create Workspace
      │
Create Project
      │
Generate API Key   (carrier_sk_…)
      │
Install CLI        (npm install -g @carrieros/cli)
      │
Login              (cos login)
      │
Interactive Shell  (cos)
      │
Chat  ·  Files  ·  Sessions  ·  Usage

Ready to install? Head to Installation, then follow the Quick Start.