跳到內容
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

系統會請你選擇登入方式（API 金鑰或電子郵件 + 密碼），並可選擇設定 profile 名稱與 SDK 環境。

使用 API 金鑰登入

建議用於 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