AgentKit
Tài liệuBộ kitTham chiếu CLIỨng dụng Desktop
BetaBạn đang đọc tài liệu kênh beta (3.0.0-beta.15). Tính năng có thể thay đổi trước bản stable tiếp theo.Chuyển sang stable →

Tham chiếu CLI

ak login

Xác thực với registry AgentKit bằng license key, email OTP hoặc user API key, đồng thời hiểu rõ ranh giới lưu credential.

Dùng ak login trước khi cài hoặc cập nhật Kit remote có license. Bạn phải chọn một phương thức xác thực; ak login trần không mở trình chọn phương thức tương tác.

Cách dùng

ak login [flags]

Lệnh được công bố không có argument theo vị trí. Implementation hiện tại bỏ qua token theo vị trí thừa; đừng dựa vào hành vi này trong script.

Trước khi chạy

Chọn một phương thức:

ak login --api-key ak_live_... --no-interactive
ak login --email you@example.com
ak login --license-key ak_license_... --no-interactive

Hãy dùng placeholder trong script được lưu hoặc đầu ra hỗ trợ. Kết quả thành công không in API key, license key, OTP, access token hay refresh credential.

API key và license key khác nhau

--api-key dành cho chủ sở hữu Kit: xác thực CLI bằng user API key gắn với một Kit đã mua trực tiếp, seat trong team hoặc suất waitlist trả phí. --license-key dành cho AgentKit App: kích hoạt device session từ App license và bản thân nó không cấp quyền CLI truy cập Kit. Một tài khoản có thể có một trong hai, cả hai, hoặc không có cái nào; hãy xác minh bằng ak whoami --json và ak licenses --json, xem thêm Xử lý sự cố xác thực để biết các lỗi từ chối cụ thể.

Đăng nhập bằng email chỉ chạy tương tác. Lệnh cần terminal ở cả stdin và stdout, và từ chối bắt đầu khi có --yes, --json, --no-interactive hoặc --quiet. Khi đó lệnh thoát 2 trước khi liên hệ registry và chỉ bạn sang --api-key, là phương thức dành cho script và CI.

Tuỳ chọn

CờMặc địnhMô tả
--api-key <key>TrốngXác thực bằng user API key từ web profile.
--device-name <name>HostnameĐặt tên device do --license-key tạo.
--email <address>TrốngBắt đầu đăng nhập email OTP trong terminal tương tác rồi đọc code từ stdin.
--license-key <key>TrốngKích hoạt phiên App device bằng license key.
--registry-url <url>Biến môi trường hoặc mặc định của bản phát hànhGhi đè registry dùng để xác thực và kiểm tra phiên sau này.

Các cờ dùng chung được mô tả trong quy ước CLI. --yes không có tác dụng với lệnh này. Nếu truyền nhiều cờ phương thức, thứ tự ưu tiên hiện tại là license key, rồi API key, rồi email; hãy chỉ truyền đúng một cờ.

Lưu credential

Sau khi registry chấp nhận credential, AgentKit ghi các tệp riêng tư dưới ~/.agentkit/auth/ (AGENTKIT_HOME thay đổi thư mục gốc):

Phương thứcSlot được lưuSecret có thể gia hạn được giữ cục bộ
API keyCLI slot trong session.jsonAPI key trong tệp api-key cùng cấp để mint lại phiên.
Email OTPCLI slot trong session.jsonRefresh credential luân phiên; OTP dùng một lần không được lưu.
License keyApp slot trong session.jsonPhiên device được trả về; license key không được lưu.

Credential được ghi atomically, dùng bảo vệ đường dẫn riêng tư và từ chối ghi qua symlink tại tệp credential. CLI slot và App slot có thể cùng tồn tại; đăng nhập CLI không thay thế phiên App device hiện có.

Đầu ra và luồng

Đầu ra thành công dành cho người dùng được ghi ra stdout:

[OK] logged in as you@example.com

JSON thành công là một envelope có phiên bản trên stdout:

{"schema_version":1,"kind":"auth.login","data":{"email":"you@example.com","authMethod":"api_key","success":true}}

Lỗi runtime và xác thực dùng stderr. Lỗi trong chế độ JSON, kể cả lỗi phân tích cờ (mã thoát 2), kết thúc stderr bằng error envelope dùng chung.

Kết quả và mã thoát

Mã thoátÝ nghĩaBước tiếp theo an toàn
0Xác thực registry thành công và slot cục bộ đã chọn đã được lưu.Chạy ak whoami và ak licenses.
1Chưa chọn phương thức, stdin OTP kết thúc, registry từ chối request, response thiếu dữ liệu hoặc lưu riêng tư thất bại.Sửa phương thức hoặc credential rồi thử lại; không đưa secret vào log.
2Không parse được cờ, hoặc đăng nhập email được gọi khi không có terminal tương tác hay có --yes, --json, --no-interactive hoặc --quiet.Sửa cách gọi; dùng --api-key cho đăng nhập bằng script.

Lệnh không có preview, dry-run, confirmation hay đường từ chối. Dữ liệu chỉ được lưu sau khi response đăng nhập từ xa hợp lệ. Chạy lại login sẽ thay slot đã chọn; dùng ak logout để xoá CLI slot.

Lệnh liên quan và giới hạn