NebulaNebula
CLI

Command reference

Every nebula-ai command in one table, plus the global flags, JSON output for scripting, shell completion, and where to find the logs.

Every nebula-ai command, what it does, and the flags that apply everywhere. Run nebula-ai <command> --help for the options on any one of them — that output is generated from the binary you have, so it's always current.

Commands

CommandWhat it does
loginAuthenticate with Nebula via device-flow pairing
logoutClear stored credentials
statusShow CLI status overview
usageShow workspace token usage and cost
chatSend a message to an agent DM and stream the response
callVoice calls
channelsManage channels (threads)
agentsManage agents — including agents skills
workspaceManage workspaces — list, switch, create
integrationsConnect and manage workspace integrations
userYour profile and account settings — see below
profileYour public profile — get, set, set-email, verify-email, upload-avatar
local-deviceManage computer control and the local device daemon
installSet up computer control — an alias of local-device enable
uninstallTurn off computer control, stop the daemon, and remove this device
capabilitiesProbe and print this host's capability snapshot
logsInspect Nebula log files on disk
updateCheck for a newer CLI version and install it
completionGenerate a shell completion script

Run nebula-ai with no command at all to open the full-screen app.

Account commands live under user

Anything that belongs to your account rather than the workspace is nested one level down, so nebula-ai user on its own prints a summary of who you're signed in as.

CommandWhat it does
user updateUpdate your username or display name
user variablesManage user variables
user configManage CLI configuration
user devicesManage your devices — user devices services covers device services
user billingManage billing and credits
user filesManage files — upload, download

Changing your email address

Your email is the one profile field you can't set outright — changing it takes proof that you can receive mail at the new address, so it runs in two steps.

Run nebula-ai profile set-email <address>. Nebula mails a six-digit code to the new address and tells you your current address hasn't changed yet.

Run nebula-ai profile verify-email <code> with the code from that mail. Only then does the address actually change.

Codes expire after 15 minutes; request another with set-email if yours runs out. nebula-ai profile get marks an address that hasn't been confirmed yet with (unverified).

nebula-ai profile set --email no longer works and will tell you so. Use the two commands above instead.

Global flags

These work on every command.

FlagWhat it does
--jsonOutput raw JSON
--workspace <id>Run against a specific workspace, ignoring the active one
-v, --verboseVerbose output — the same as --log-level=debug
--log-level <level>One of error, warn, info, debug, trace
--no-colorDisable colours
--api-url <url>Point at a different API host

Scripting

--json turns any command into something you can pipe. It's a global flag, so it works the same everywhere.

nebula-ai call list --json | jq -r '.[] | .title'
$ nebula-ai call list --json | jq -r '.[] | .title'
Launch retro
Design sync

Combine --json with --workspace in CI so a script never depends on whichever workspace happened to be active on that machine.

Shell completion

nebula-ai completion prints a completion script for bash, zsh, or fish — source it from your shell profile.

nebula-ai completion zsh > ~/.nebula-completion.zsh
$ nebula-ai completion zsh > ~/.nebula-completion.zsh
# then add: source ~/.nebula-completion.zsh

When something goes wrong

nebula-ai status shows whether you're signed in and which workspace you're pointed at — most surprises are one of those two. nebula-ai capabilities reports what this machine supports, like whether ffmpeg is available for camera.

nebula-ai logs inspects the log files, and nebula-ai logs path prints where they live (~/.nebula/logs/). Re-run a failing command with -v for the detail.

nebula-ai update checks for a newer version and installs it. Worth trying before reporting anything.

Still stuck? Ask Nebula directly — it's good at drafting a support email with the right detail in it. For bugs or anything unresolved, email support@nebula.gg.

On this page