Tham chiếu CLI AgentKit

Tìm lệnh ak phù hợp với mục tiêu, sau đó xem cú pháp, tác động, đầu ra và hướng dẫn khôi phục chính xác.

Hãy dùng phần tham chiếu này khi bạn đã biết mình muốn đạt kết quả gì và cần lệnh ak, cờ, hợp đồng đầu ra hoặc quy tắc mã thoát chính xác. Nếu đây là lần đầu bạn thiết lập AgentKit, hãy bắt đầu với hướng dẫn nhanh.

Duyệt theo kết quả mong muốn bên dưới, hoặc dùng thanh bên Tham chiếu CLI để mở bất kỳ lệnh nào.

Phạm vi lệnh và nội dung trợ giúp không bảo đảm hành vi runtime giống hệt nhau giữa các bản phát hành. Trước khi dùng một lệnh trong tự động hoá, hãy đọc phần tác động, đầu ra và mã thoát trên trang của lệnh đó.

Tìm lệnh theo kết quả mong muốn

Kết quả mong muốn	Bắt đầu với	Lệnh thường dùng
Cấu hình quyền truy cập và tuỳ chọn	Nhóm lệnh tài khoản và cấu hình	`ak login`, `ak whoami`, `ak licenses`, `ak setup`, `ak config`
Tạo hoặc đăng ký project	Nhóm lệnh vòng đời project	`ak init`, `ak new`, `ak projects`
Cài capability cho runtime	Nhóm lệnh Kit và component	`ak kit`, `ak skills`, `ak agents`, `ak commands`, `ak skill`
Chạy và kiểm tra công việc	Nhóm lệnh thực thi và hoạt động	`ak run`, `ak activity`, `ak sessions`, `ak content`, `ak data`, `ak analytics`
Lập kế hoạch và kết nối công cụ	Nhóm lệnh kế hoạch và tích hợp	`ak plan`, `ak journal`, `ak mcp`, `ak api`, `ak watch`
Chẩn đoán và khôi phục	Nhóm lệnh sức khoẻ và khôi phục	`ak doctor`, `ak audit`, `ak diagnostics`, `ak backups`, `ak recover`, `ak migrate`
Cập nhật hoặc gỡ cài đặt	Nhóm lệnh bảo trì	`ak update`, `ak self-update`, `ak versions`, `ak changelog`, `ak uninstall`

Một số lệnh hỗ trợ nhiều kết quả. Hãy mở trang lệnh để xem đường dẫn, cờ và subcommand chính xác.

Quy trình thường dùng

Kiểm tra tình trạng cài đặt

Chạy báo cáo sức khoẻ và đọc trường sức khoẻ lồng bên trong:

ak doctor --json | jq '.data.healthy'

Dùng ak doctor --exit-on-fail khi một phép kiểm tra sức khoẻ thất bại phải tạo mã thoát khác không. Xem ak doctor để hiểu hành vi mạng, sửa chữa, đầu ra và mã thoát.

Chuẩn bị project và cài Kit

Dùng lệnh riêng cho từng mục tiêu vòng đời:

# Register AgentKit ownership in an existing directory.
ak init

# Create a new project directory.
ak new my-project

# Install a kit into a selected runtime.
ak kit init engineer --target codex

Hãy xem ak kit init trước khi viết script cài đặt.

Cập nhật đúng lớp

# Check only the AgentKit binary.
ak self-update --check

# Preview or apply the unified update workflow.
ak update

# Refresh one installed kit route.
ak kit refresh engineer --target codex --yes

Binary, trình cập nhật hợp nhất và Kit refresh có tác động cùng hành vi xác nhận khác nhau. Hãy chọn lệnh khớp với lớp bạn thực sự muốn thay đổi.

Kiểm tra recovery snapshot

ak backups list
ak backups show <id>
ak backups verify <id>
ak recover <id> --dry-run

Recovery snapshot chỉ bao phủ các bề mặt do AgentKit quản lý đã được ghi lại. Đây không phải bản sao lưu toàn bộ máy, và quá trình khôi phục nhiều tệp không đảm bảo tính giao dịch.

Dùng lệnh an toàn

Xem lại hành vi riêng của từng lệnh: Cờ dùng chung không khiến mọi lệnh có cùng hợp đồng xác nhận, JSON hoặc mã thoát.
Xem --json là lựa chọn đầu ra: Cờ này ngầm bật chế độ không tương tác, và một số lệnh thay đổi dữ liệu có thể tiếp tục mà không hỏi thêm.
Dùng --yes có chủ đích: Chỉ thêm cờ này sau khi kiểm tra kỹ target, scope, mode và thao tác. Không phải mọi đường thay đổi đều bắt buộc có cờ này.
Không xem preview là offline: Một số quy trình từ xa có thể liên hệ registry, gia hạn xác thực, tải artifact hoặc ghi verified cache trước khi thay đổi target chính.
Giữ lại dữ liệu khôi phục: Giữ mọi snapshot ID hoặc đường dẫn khôi phục thủ công được báo cáo cho đến khi bạn đã xác minh kết quả.
Tránh dọn dẹp diện rộng: Không xoá toàn bộ thư mục home của runtime hoặc AgentKit chỉ để khôi phục sau một lệnh.

Cú pháp và hành vi dùng chung

Đọc quy ước CLI để biết các cờ và chế độ hiển thị dùng chung. Sau đó, mở trang của từng lệnh để xem argument, cờ riêng, tác động, luồng đầu ra và mã thoát đã phân loại chính xác.

On this page