Skip to main content
To manage a remote deployment from your own machine, install the CLI with uv:
The Docker quickstart includes the CLI in the image and also offers setup through the web app.From its Compose directory, prefix commands with docker compose exec app, for example docker compose exec app airmux doctor.

Sign in

Start the browser sign-in flow for your deployment:
The CLI prints a code and opens a browser. Complete sign-in there, then return to the terminal. If the machine has no browser, add --no-browser and open the printed URL yourself. Check the saved context and connection:
status shows the effective organization, workspace, and credential source. Select credentials with airmux profiles use <profile>. Select an organization with airmux organizations switch <organization-id> and a workspace with airmux workspaces use <workspace>. These selections also work with instance and environment management keys.

Manage a workspace

Create a workspace, then select it for subsequent commands:
Add a provider credential. The command prompts for the secret, so it does not need to appear in shell history:
Create an inference key for applications. Copy the secret when it is printed (it is shown only once):
List policies and recent usage events:
Use --organization <organization-id> on an organization-scoped command to target another organization for that command. Use --workspace <slug-or-id> to target another workspace. An explicit organization requires an explicit workspace when the saved workspace belongs to a different organization. Commands that return resources accept -f json for scripting and -f table for terminal output. For example:
Run airmux <group> <command> --help for command options. See the CLI reference for authentication contexts, output formats, and the full command list.