---
title: "CLI"
description: "Command-line reference for airuntime: login, Workspaces, API keys and Pools."
---

> Documentation Index
> Fetch the complete documentation index at: https://help.airuntime.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

`airuntime` is the command-line client for the control plane. It authenticates a machine, then
manages Workspaces, API keys and Pools without opening the console.

## Commands

| Command | Verbs | What it does |
| --- | --- | --- |
| `login` | — | Authorize this machine against a control plane |
| `logout` | — | Revoke the machine credential and remove it from disk |
| `whoami` | — | Show the identity behind the stored credential |
| `workspaces` | `list`, `create`, `config` | List, create and inspect Workspaces |
| `api-keys` | `list`, `issue`, `rotate`, `revoke` | Manage Workspace API keys |
| `pools` | `configure`, `update-policy`, `set-status` | Create or replace a Pool, update its policy, activate or pause it |

## Global flags

| Flag | Meaning |
| --- | --- |
| `--origin <url>` | Control plane origin. Defaults to `https://console.airuntime.dev` |
| `--json` | Machine-readable JSON on stdout, with no ANSI escapes |
| `--no-color` | Disable ANSI styling in human output |
| `--help`, `-h` | Help for the current command |
| `--version`, `-v` | Print the CLI version |

## Environment

| Variable | Meaning |
| --- | --- |
| `AIRUNTIME_ORIGIN` | Default control-plane origin, used when `--origin` is absent |
| `AIRUNTIME_CLI_TOKEN` | Token to use instead of the stored credential |
| `XDG_CONFIG_HOME` | Where `credentials.json` is kept |

## Examples

```bash
airuntime login --open
airuntime workspaces list --json
airuntime api-keys issue --workspace ws_1 --label checkout --pool pool_1
airuntime pools update-policy --workspace ws_1 --pool pool_1 \
  --from-json policy.json --rate-limit 600
```

Use the pool’s current version in `policy.json` (field `expectedUpdatedAt`) to prevent overwriting a concurrent change.

`--help` prints to stdout and exits `0`; an unknown command prints the same help to stderr and exits
`2`, so scripts can tell "asked for help" from "typed it wrong".

Source: https://help.airuntime.dev/reference/index.mdx
