Chuyển đến nội dung

Cài đặt

Cài đặt CLI

Gói npm công khai

Terminal window
npm install -g @imbrace/cli

Từ mã nguồn

Clone kho lưu trữ và chạy script cài đặt:

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

install.sh chạy bun install (hoặc npm install nếu không có Bun), npm run build, npm link, sau đó tạo symlink imbrace vào /opt/homebrew/bin (Apple Silicon) hoặc /usr/local/bin (Intel).

Biên dịch thủ công

Terminal window
cd cli
npm install
npm run build
npm link

Xác thực

Các lệnh tài nguyên (ai-agent, data-board, document-ai, guardrail, orchestrator, workflow) sẽ tự động yêu cầu đăng nhập nếu chưa được xác thực với profile đã xác định. Các lệnh xác thực và quản lý profile (login, logout, whoami, docs, profile) không tự động yêu cầu đăng nhập.

Thông tin xác thực và cấu hình môi trường được lưu trong các profile. Thứ tự ưu tiên: cờ --profile > biến môi trường IMBRACE_PROFILE > cấu hình active_profile > "default".

Đăng nhập tương tác

Không truyền cờ nào để được hỏi tương tác:

Terminal window
imbrace login

Bạn sẽ được yêu cầu chọn phương thức (API Key hoặc Email + Mật khẩu), và tùy chọn đặt tên profile cùng môi trường SDK.

Đăng nhập với API Key

Khuyến nghị cho CI/CD và các tác nhân lập trình:

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

Các cờ bổ sung: --base-url, --timeout, --check-health, --services.

Đăng nhập với Email + Mật khẩu

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

Đăng nhập bằng mật khẩu sẽ xác định tổ chức trước khi lưu thông tin xác thực: nếu tài khoản chỉ thuộc một tổ chức thì tự chọn; nếu thuộc nhiều tổ chức, hãy truyền --org-id <id> (hoặc chọn tương tác khi chạy trong terminal). CLI lưu token gắn theo tổ chức đó, nên các lệnh sau chạy trên đúng tổ chức.

Kiểm tra đăng nhập hiện tại

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

Đăng xuất

Xóa thông tin xác thực của profile đang hoạt động (hoặc profile được chỉ định):

Terminal window
imbrace logout
imbrace logout --profile work

Cập nhật CLI

Từ v0.6.8 trở đi, CLI có lệnh tự cập nhật tích hợp:

Terminal window
imbrace update # cập nhật lên phiên bản mới nhất
imbrace update --check # kiểm tra cập nhật mà không cài đặt
imbrace update --version 0.6.7 # cài đặt phiên bản cụ thể

Với các phiên bản cũ hơn v0.6.8, cập nhật thủ công:

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

Lưu trữ thông tin xác thực

Hệ điều hànhĐường dẫn
macOS~/Library/Preferences/imbrace-nodejs/config.json
Linux~/.config/imbrace-nodejs/config.json
Windows%APPDATA%\imbrace-nodejs\Config\config.json