# @astralbeam/cli 中文文档

规范地址：https://npmcn.com/package/%40astralbeam/cli/

版本：0\.30\.1
npm 元数据更新时间：2026-11-07T11:00:32.294Z
中文译文更新时间：2026-11-07T01:02:01.878Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40astralbeam/cli
原文对照：https://npmcn.com/package/%40astralbeam/cli/?lang=original
项目主页：https://astralbeam.ai/docs/cli/getting-started
源码仓库：https://github.com/AstralBeamAI/astralbeam

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：403 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12
- 运行依赖：0 个
- 首次发布：2026-09-24T15:01:50.507Z
- 最新版本发布：2026-11-07T11:00:31.907Z
- 近 30 天下载量：3118（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 51 个）

## 中文简介

AstralBeam 组织管理员及其编码代理的命令行界面

## 安装

```sh
npm install @astralbeam/cli
```

也可以使用：`pnpm add @astralbeam/cli`、`yarn add @astralbeam/cli`、`bun add @astralbeam/cli`

## README

# @astralbeam/ cli (英语)

管理一个AstralBeam组织的"租户和租户用户","薄荷短寿"的代币,并从终端测试其代理人. 使用 `--json` 用于脚本和编码代理.

## 安装

在22.12号节点上或以后用 npm 运行,没有安装步骤:

```sh
npx @astralbeam/cli --help
```

或者在全球安装 `astralbeam`数字 :

```sh
npm install --global @astralbeam/cli
```

每个 [GitHub 发布](https://github.com/AstralBeamAI/astralbeam/releases) 还附上需要节点的独立二进制, 命名 `astralbeam-<platform>` 页:1 `linux-x86_64`, (中文(简体) ), `linux-arm64`, (中文(简体) ), `macos-x86_64`, (中文(简体) ), `macos-arm64`,以及 `windows-x86_64.exe`编辑 `releases/latest/download` URL总是服务于最新的发布,因此重新运行下载升级CLI.

```sh
curl -fsSLo astralbeam https://github.com/AstralBeamAI/astralbeam/releases/latest/download/astralbeam-macos-arm64
chmod +x astralbeam
mv astralbeam /usr/local/bin/astralbeam
```

**页:1**: 二进制没有签名. 在 macOS 上,通过浏览器下载的二进制 `xattr -d com.apple.quarantine <file>` 在它第一次运行之前.

## 签名

在仪表板下创建 API 密钥 **API 密钥**,然后从您在组织上工作的目录中登录。 提示会隐藏被粘贴的密钥,而管状的斯丁也起作用:

```sh
cd ~/work/acme
astralbeam auth login
```

`login` 阅读组织名称和来自API的弹出,它也证明了关键作品,然后将钥匙绑入该目录及其下方的一切. 捆绑住 `~/.config/astralbeam/config.json` (单位:千美元)`%APPDATA%\astralbeam` 在 Windows 上),具有仅所有者权限,在目录本身中从未出现. 为了管理另一个组织,请从自己的目录中再次登录。 自行部署,通过 `/api` 基础 :

```sh
cd ~/work/globex
astralbeam auth login --api-url https://beam.example.com/api
```

每个命令然后使用它运行位置或上方最近的绑定目录,并先打印组织来分解,所以stdout仍可解析:

```text
▸ Acme (acme) · org 01990a5d-… · bound at ~/work/acme
```

一个没有约束祖先的目录在退出代码1上失败了,而不是猜测一个组织. 对于CI和特工,设置 `ASTRALBEAM_API_KEY`,它优先于任何约束,以及 `ASTRALBEAM_API_URL` 当自会. URL还覆盖了绑定键所保存的 URL . `ASTRALBEAM_CONFIG_DIR` 选择包含 `config.json`. API URL需要HTTPS,除了回转主机上的HTTP(`localhost`, IPv4 软件 `127.0.0.0/8`,或 `[::1]`) (中文(简体) ).

检查绑定命令将使用, 或者列出全部 :

```sh
astralbeam auth status
astralbeam auth list
```

## 图标

| 命令 | 对 |
| --- | --- |
| `auth login`, (中文(简体) ), `auth logout`, (中文(简体) ), `auth status`, (中文(简体) ), `auth list` | 捆绑、 取消捆绑、 校验和列表目录登录 |
| `tenants list`, (中文(简体) ), `get`, (中文(简体) ), `create`, (中文(简体) ), `update` | 管理租户 |
| `tenant-users list`, (中文(简体) ), `get`, (中文(简体) ), `create`, (中文(简体) ), `update` | 管理租户的用户 |
| `tenant-users usage get` | 在一个时间范围内以美元阅读用户的使用情况 |
| `threads`, (中文(简体) ), `organization` | 读取线索目录数据和组织细节 |
| `tenants threads messages list` | 读取保存的对话信件 |
| `token chat` | 给租户的用户装个聊天机 JWT , 作为您的标语终点 |
| `token organization` | JWT为一名成员制作的 " 组织-管理薄荷 " |
| `chat` | 作为租户用户与代理商聊天 |
| `skill`, (中文(简体) ), `skill install` | 打印或安装捆绑的代理技能 |

运行 `astralbeam <command> --help` 每个旗帜。 租户名单 `--external-id`, (中文(简体) ), `-q` 编号 : `--search`, (中文(简体) ), `--page-size`, (中文(简体) ), `--page-after`,以及 `--page-before`。租户使用人名单也采用 `--admin true|false`并接受 `--body '<json>'` 或者说 `--body @file.json`名称 `--body '{"name":null}'`。 。 。 .

福尔吉的 `--dry-run` 打印本地 JSON 请求预览,而不发送 HTTP 或与服务器验证。 它读取配置并供应 `@file` 目录.

```sh
astralbeam tenants create --external-id customer-42 --name "Acme Logistics" --metadata '{"plan":"pro"}'
astralbeam tenants list --external-id customer-42 --json
astralbeam tenant-users create <tenant-id> --external-id user-7 --name "Alex Morgan"
astralbeam chat --tenant customer-42 --user user-7 "What can you do?"
```

## 输出和退出代码

人可读取的桌子和唱片都到Stdout. 与 `--json`,记录和页面以 API 格式保存,非交互操作写入一个 stderr 对象 : `{"context": {...}}` 成功时或 `{"error": {...}, "context": {...}}` 失败。 API 故障保留其问题细节, 而运行时间和使用错误提供 `error.detail`。帮助和版本输出仍为纯文本。 命令以 `0` 关于成功, `1` 当 API 、 生成输入处理或运行时间失败时,以及 `2` 用于解析器使用错误.

对于出乎意料的失败, 请使用 `--debug` 以登录 HTTP 方法、 URL 、 状态、 持续时间和堆栈跟踪到 stderr , 没有标题。 它增加了JSON对象以外的行. 写入失败后, 请在重试前检查是否成功 .

## 编码代理

CLI号飞船 [特工技能](https://npmcn.com/package/%40astralbeam/skills/astralbeam/SKILL.md) 用于应用集成和CLI使用. 把它安装到当前工程中 `.agents/skills` 目录 :

```sh
astralbeam skill install
```

提交 `.agents/skills/astralbeam/SKILL.md` 与团队分享,并在新的结账中提供。 克劳德代码,通过 `--dir .claude/skills`启用 `--dir <path>` 用于另一个工程或用户级目录。 然后通过从项目目录中登录或通过 `ASTRALBEAM_API_KEY`从来没有在提示.

整个指南在 [astralbeam.ai/docs/cli/开始](https://astralbeam.ai/docs/cli/getting-started)。 。 。 .

## 常见问题

### @astralbeam/cli 是什么？

AstralBeam 组织管理员及其编码代理的命令行界面

### 如何安装 @astralbeam/cli？

在项目目录运行 npm install @astralbeam/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 astralbeam，可以用 npx astralbeam 直接运行。

### @astralbeam/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/astralbeam\_\_cli 是否存在。

### @astralbeam/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @astralbeam/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @astralbeam/cli 可以商用吗？

@astralbeam/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @astralbeam/cli 的下载量有多少？

根据 npm 官方下载统计，@astralbeam/cli 在 2026/10/07 – 2026/11/05 这 30 天内被下载 3,118 次，日均约 104 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @astralbeam/cli 还在维护吗？

最新版本 0\.30\.1 发布于 2026/11/07（今天）；至今共发布 51 个版本，其中过去 12 个月发布了 51 个；首次发布于 2026/09/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。