---
title: "CLI"
description: "airuntime 命令行参考：login、Workspace、API Key 与 Pool。"
---

> 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` 是控制面的命令行客户端。它先给机器授权，然后不开控制台也能管理 Workspace、API Key
和 Pool。

## 命令

| 命令 | 子命令 | 作用 |
| --- | --- | --- |
| `login` | — | 给这台机器授权访问某个控制面 |
| `logout` | — | 吊销机器凭据并从磁盘移除 |
| `whoami` | — | 显示已存凭据背后的身份 |
| `workspaces` | `list`、`create`、`config` | 列出、创建和查看 Workspace |
| `api-keys` | `list`、`issue`、`rotate`、`revoke` | 管理 Workspace API Key |
| `pools` | `configure`、`update-policy`、`set-status` | 创建或替换 Pool、更新策略、启用或暂停 |

## 全局参数

| 参数 | 含义 |
| --- | --- |
| `--origin <url>` | 控制面地址，默认 `https://console.airuntime.dev` |
| `--json` | stdout 输出机器可读 JSON，不带 ANSI 转义 |
| `--no-color` | 人类可读输出不带 ANSI 样式 |
| `--help`、`-h` | 当前命令的帮助 |
| `--version`、`-v` | 打印 CLI 版本 |

## 环境变量

| 变量 | 含义 |
| --- | --- |
| `AIRUNTIME_ORIGIN` | 未传 `--origin` 时使用的默认控制面地址 |
| `AIRUNTIME_CLI_TOKEN` | 替代已存凭据使用的 token |
| `XDG_CONFIG_HOME` | `credentials.json` 的存放位置 |

## 示例

```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
```

在 `policy.json` 中填写 Pool 当前的版本（`expectedUpdatedAt`），以防覆盖同时发生的更新。

`--help` 输出到 stdout 并以 `0` 退出；敲错命令时同样的帮助输出到 stderr 并以 `2` 退出，脚本因此能
区分"要帮助"和"敲错了"。

Source: https://help.airuntime.dev/zh-hans/reference/index.mdx
