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.2.0-beta.10). 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 licenses

Query trực tiếp grant Kit AgentKit bằng phiên cục bộ hiện tại và hiểu hợp đồng đầu ra dùng chung với whoami.

Dùng ak licenses trước khi cài Kit remote trả phí để xác nhận tài khoản hiện tại có grant đang hoạt động.

Cách dùng

ak licenses

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.

Tuỳ chọn

CờMặc địnhMô tả
--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 cho entitlement request.

Các cờ đầu ra dùng chung được mô tả trong quy ước CLI. Lệnh không bao giờ hỏi; --yes và --no-interactive không thay đổi hành vi.

Trước khi chạy

ak licenses dùng cùng phiên và entitlement query trực tiếp như ak whoami. Lệnh đọc ~/.agentkit/auth/session.json, trừ khi AGENTKIT_HOME thay đổi thư mục gốc. CLI slot được ưu tiên hơn App slot.

ak login --api-key ak_live_... --no-interactive
ak licenses

Khi không có phiên đã lưu, lệnh không gửi request qua mạng, in not logged in; run `ak login` to sign in, or `ak login --license-key <key>` for an AgentKit App license và thoát 1. Khi có phiên, lệnh kiểm tra registry của phiên, yêu cầu grant hiện tại và có thể xoay hoặc mint lại credential CLI hết hạn một lần. Việc gia hạn thành công sẽ ghi lại tệp phiên.

Không có grant cache offline và không thay đổi entitlement. Lệnh chỉ báo grant; không kích hoạt, mua, revoke hay cài Kit.

Đầu ra và luồng

Stdout dành cho người dùng bắt đầu bằng [OK] logged in as <email>, rồi từng grant kit (status). Khi không biết email, dòng này nêu phương thức đăng nhập (logged in with a license key, logged in with an API key hoặc logged in by email); danh sách grant rỗng in no licensed kits. Email lấy từ email đã ghi lúc đăng nhập. Dù phần trợ giúp tập trung vào Kit, lệnh dùng cùng view model với ak whoami.

JSON cũng chủ đích dùng chung kind=auth.whoami, không dùng kind auth.licenses riêng:

{
  "schema_version": 1,
  "kind": "auth.whoami",
  "data": {
    "authenticated": true,
    "email": "you@example.com",
    "authMethod": "api_key",
    "licenses": [
      {"kitId":"engineer","status":"active","grantType":"license","productId":"engineer"}
    ]
  }
}

Khi không có phiên đã lưu, --json in error envelope chung trên stderr với auth.reason: "not_logged_in", error_code: "unknown" và exit_code: 1; stdout để trống. Lỗi runtime, registry và session dùng cùng error envelope trên stderr. Khi bật --json, cờ không xác định hoặc không hợp lệ dùng JSON error envelope chung trên stderr (error_code: validation_failed, mã thoát 2). Chế độ human, kể cả --json=false, in Usage.

Cửa sổ cập nhật

Khi registry áp dụng cửa sổ cập nhật, mỗi license còn báo bạn có thể cài bản phát hành mới của Kit đó hay không. Các phiên bản đã sở hữu dùng được vĩnh viễn; cửa sổ chỉ bao phủ các bản phát hành mới.

Đầu ra cho người đọc thêm, theo từng Kit, trạng thái, ngày cập nhật được bao phủ đến, patch line, phiên bản mới nhất còn được bao phủ, nguồn của quyền cập nhật và liên kết Renew updates khi bản mới hơn cần gia hạn. Với --json, mỗi mục licenses[] có thêm đối tượng updates, và data.updates.schemaVersion cho biết phiên bản payload của cửa sổ cập nhật:

{
  "kitId": "engineer",
  "status": "active",
  "updates": {
    "state": "expired",
    "updatesThrough": "2026-01-31T00:00:00.000Z",
    "patchLine": "3.1",
    "latestEntitledVersion": "3.1.4",
    "entitlementSource": [{"type": "license", "status": "active"}],
    "renewUrl": "https://agentkit.best/account/updates"
  }
}

state là một trong not_owned, unlimited, active, expired hoặc unknown. Sau khi cửa sổ expired, các bản vá trên patchLine vẫn cài được. Các trường updates không có khi registry không áp dụng cửa sổ, nên hãy coi chúng là tùy chọn. Chúng chỉ mang tính thông tin: bản sao đã cache không bao giờ làm một phiên bản mới hơn cài được, và cửa sổ đã kết thúc không bao giờ vô hiệu hóa Kit đã cài. Xem Cửa sổ cập nhật và gia hạn.

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

Mã thoátÝ nghĩaBước tiếp theo an toàn
0Query hoàn tất với phiên đã đăng nhập, kể cả danh sách grant rỗng.Kiểm tra licenses[].kitId và status tương ứng.
1Không có phiên đã lưu, session store lỗi, registry mismatch, gia hạn thất bại hoặc grant request trực tiếp thất bại.Chạy ak login (hoặc ak login --license-key <key>), hoặc xác thực lại với registry dự định dùng rồi thử lại.
2Không parse được cờ.Sửa cách gọi.

Lệnh không có preview, apply, force, backup hay rollback. Gia hạn credential là thay đổi cục bộ duy nhất có thể xảy ra.

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