Quick Start

Sign in and start chatting in the interactive shell in under a minute.

  1. 1

    Point at your API (optional)

    The CLI defaults to https://api.carrieros.ai/v1. To target a local or self-hosted instance, set the endpoint once with --url:
    bash
    cos login --url http://localhost:5000/v1
  2. 2

    Log in

    Run login and paste your secret key when prompted. It is stored securely on your machine and verified before it is saved.
    bash
    cos login
# carrier_sk_…  ›  (paste your key)
  3. 3

    Verify the setup

    doctor checks your config, connectivity, and key.
    bash
    cos doctor
  4. 4

    Check your account

    bash
    cos whoami
  5. 5

    Start the shell

    Run cos with no command to enter the interactive shell.
    bash
    cos
Your key is saved to %APPDATA%/CarrierOS/config.json (or ~/.carrieros/config.json). The CLI stores only the secret key, active session, mode/model preference, and a cached scope — never a login token.
Learn the shell in Interactive Shell, or browse every command in Commands.