First Run Experience
The very first time you launch the CLI without a saved key, it walks you through sign-in, then drops you into the shell.
What happens on first launch
Run cos before logging in and the CLI shows a branded welcome, prompts for your secret key, verifies it against the API, and — on success — opens the interactive shell with your workspace and project already loaded.
text
$ cos
██████╗ █████╗ ██████╗ ██████╗ ██╗███████╗██████╗
██║ ███████║██████╔╝██████╔╝██║█████╗ ██████╔╝
Welcome to Carrier OS
No API key configured.
Paste your Carrier API Secret Key
(or type /exit)
carrier_sk_… › ••••••••••••••••••••
✓ Authentication Successful
Workspace Default workspace
Project Project A
Ready.The key is entered securely
- The prompt is masked as you paste — the key is never echoed.
- It is verified with the API before it is saved, so an invalid key never gets stored.
- On success it is written to
%APPDATA%/CarrierOS/config.json(or~/.carrieros/config.json).
Targeting a local or self-hosted API? Set the endpoint first with
cos login --url http://localhost:5000/v1, then launch the shell.Subsequent launches
Once a key is saved, cos skips sign-in and opens straight into the shell — showing the welcome banner and your current context. Sign out any time with /logout.
See the full walkthrough in the Quick Start, and learn the prompt in Interactive Shell.