Cue CLI setup

Cue CLI is the terminal app for Cue OS. This page installs it on macOS or Linux, connects it to your Cue OS account or an AI provider, and checks that Cue, the native agent, can answer.

What you can do

Install Cue CLI with one command.
Sign in with a Cue OS account, or set up with an API key and no prompts.
Check that the install works, and switch between saved accounts.

Before you start

macOS or Linux, on an x64 or arm64 computer. On Windows, follow the Windows guide.
Node.js 22.13.0 or later. Check node --version; if it is missing or too old, install or upgrade Node.js from nodejs.org. The installer checks the full version and stops before downloading Cue CLI if it is unsupported.
A Cue OS account. Anyone can sign up.

With Cue CLI

Open a terminal and run the installer:
```
curl -fsSL https://cueos.ai/install.sh | bash
```
It downloads Cue CLI, checks the download's SHA-256 fingerprint, and adds cue to your shell's command path. To see what it would do first, add -s -- --dry-run after bash.
Open a new terminal window, then check the version:
```
cue --version
```
If the terminal says cue is not found, the installer's note shows the export PATH=... line to run in the current window.
Start the setup wizard, and follow the account and provider choices:
```
cue onboard
```
Setup Complete means Cue can try to chat. Workspace Ready means the files are in place but you still need to finish the account or provider step.
Check the installation, then send a small request:
```
cue doctor
cue run "Reply with hello" --json
```
Run cue doctor after onboarding. Before setup it reports a missing account, which does not mean the install is broken. If the request fails, read the account or provider problem it reports before trying again.

A terminal showing cue --help, with the usage line, the version and build, and the Learn section that explains how to discover commands

Set up without the wizard

For a server or a script, use a Cue API key instead of the wizard.

On the web, open Settings, choose API Keys, and select Create API Key. Copy the key when it is shown; you cannot see it again.

Put the key in the CUE_API_KEY environment variable, then run:

cue onboard --non-interactive --workspace "$PWD" \
  --cue-api-key "$CUE_API_KEY" --provider cue --json

Check the exit code, errors, warnings, and readiness.readyToChat in the result. A prepared workspace alone does not mean Cue can answer.
Send the small request from step 4 above. Run cue onboard --help for account, agent, provider, and model options.

Choose an account

If you have saved more than one account, list them, check which one a command will use, and pick one for a single command:

cue auth list --json --summary
cue --profile <account> auth --json
cue --profile <account> run "Reply with hello" --json

Global options such as --profile and --agent go before the command. See Authentication to sign in, switch, and sign out.

On the web

Setup happens in a terminal. The web is where you create your account and, for setup without the wizard, create an API key under Settings → API Keys.

On iPhone and Android

The iPhone and Android apps are coming; store review is pending. You can use Cue OS in your phone browser now. Cue CLI cannot be installed on a phone.

Limits today

The installer uses the beta channel. The dev channel changes faster: curl -fsSL https://cueos.ai/install.sh | bash -s -- --channel dev.
Windows works only through WSL2. See the Windows guide.
Installing with npm or bun is not available; use the installer above.
cue doctor --all prints a full report for troubleshooting. It can include account details, so read it before you share it.

Cue CLI on Cue OS · Authentication · Windows · Cue Desktop · cue onboard reference · Cue CLI command reference

On this page