Skip to main content
The Aether CLI manages projects, tasks, and cloud workspaces from your terminal. It connects to the Aether API, follows long-running agent tasks, and exposes every part of the platform that the web app does. Install it with the install script or Homebrew, then run the interactive setup:

Global Flags

These persistent flags are available on every command.

Configuration

The CLI stores configuration in ~/.aether/config.json, created on first login. It holds your default project, API URL, and authentication tokens. Set AETHER_CONFIG_DIR to use a different directory. Manage non-sensitive config keys with aether config.

Environment Variables

Environment variables take precedence over the config file.

Command Groups

Core

Workspace

Integrations

Configuration

Three commands sound alike but manage three different kinds of credential. Don’t mix them up:

Resolving IDs (Short Prefixes)

Most commands that take an <id> argument — project, task, workspace, and token — accept a short prefix instead of the full UUID. For projects, tasks, and workspaces the prefix is matched against the first characters of the ID (the listings print the first 8 characters); for tokens, any unique prefix works.
Resolution fails loudly: an unknown prefix returns “no … found matching”, and a prefix that matches more than one record returns an “ambiguous prefix” error asking for a longer prefix. Values containing a - or 32+ characters are treated as full IDs and used as-is.

Profile

Print the current user’s profile (email, ID, display name, onboarding status).

Version

Print version, commit, Go version, and OS/arch.
The CLI docs are hand-written and verified against the source commands. They are not generated from the binary.