跳转到内容
Imbrace SDK

安装

安装 CLI

公共 npm 包

Terminal window
npm install -g @imbrace/cli

从源码安装

克隆仓库并运行安装脚本：

Terminal window
git clone https://github.com/imbrace-co/imbrace-cli.git
cd imbrace-cli
./install.sh

install.sh 依次运行 bun install（如果没有 Bun 则运行 npm install）、npm run build、npm link，然后将 imbrace 符号链接到 /opt/homebrew/bin（Apple Silicon）或 /usr/local/bin（Intel）。

手动构建

Terminal window
cd cli
npm install
npm run build
npm link

认证

资源命令（ai-agent、data-board、document-ai、guardrail、orchestrator、workflow）在解析出的 profile 未认证时会自动提示登录。认证和 profile 管理命令（login、logout、whoami、docs、profile）不会自动提示。

凭证和环境设置保存在 profile 中。解析顺序：--profile 参数 > IMBRACE_PROFILE 环境变量 > active_profile 配置 > "default"。

交互式登录

不传任何参数即可进入交互式提示：

Terminal window
imbrace login

CLI 会让你选择登录方式（API Key 或邮箱 + 密码），并可选择设置 profile 名称和 SDK 环境。

使用 API Key 登录

推荐用于 CI/CD 和编码代理：

Terminal window
imbrace login --api-key api_xxx...
imbrace login --api-key api_xxx... --profile work
imbrace login --api-key api_xxx... --profile dev --env sandbox --org-id org_xxx

其他参数：--base-url、--timeout、--check-health、--services。

使用邮箱 + 密码登录

Terminal window
imbrace login --email user@example.com --password mypass
imbrace login --email user@example.com --password mypass --profile personal
imbrace login --email user@example.com --password mypass --org-id org_xxx

密码登录会在保存凭证前先确定组织：如果账户只属于一个组织，则自动选择；如果属于 多个组织，请传入 --org-id <id>（或在终端中交互式选择）。CLI 会保存绑定该组织的 令牌，因此后续命令都在该组织下运行。

查看当前登录状态

Terminal window
imbrace whoami
imbrace whoami --json
imbrace whoami --profile work

退出登录

清除当前（或指定）profile 的凭证：

Terminal window
imbrace logout
imbrace logout --profile work

更新 CLI

从 v0.6.8 起，CLI 内置自更新命令：

Terminal window
imbrace update              # 更新到最新版本
imbrace update --check      # 检查更新但不安装
imbrace update --version 0.6.7  # 安装指定版本

v0.6.8 之前的版本请手动更新：

Terminal window
npm install -g @imbrace/cli@latest

凭证存储

操作系统路径
macOS~/Library/Preferences/imbrace-nodejs/config.json
Linux~/.config/imbrace-nodejs/config.json
Windows%APPDATA%\imbrace-nodejs\Config\config.json