ak plan
ak plan
Chọn đúng lệnh cho thư mục plan hoặc vòng đời của plan store riêng tư trên máy.
Dùng ak plan làm namespace để thao tác với tệp plan của AgentKit và chỉ mục
plan cục bộ. Bản thân lệnh nhóm chỉ in trợ giúp; hãy chọn một lệnh con để đọc
hoặc thay đổi plan.
Cách dùng
ak planLệnh nhóm không nhận argument theo vị trí và không có cờ riêng. Các cờ dùng
chung được mô tả trong quy ước CLI, nhưng
ak plan --json không phải thao tác dữ liệu JSON: lệnh cha không có renderer và
vẫn hiển thị trợ giúp.
Chọn đúng lớp lưu trữ
| Mục tiêu | Lệnh | Nguồn sở hữu chính | Hiệu ứng |
|---|---|---|---|
| Tạo thư mục plan | ak plan create <name> | Tệp plan | Tạo plan.md và phase khởi đầu, sau đó cố gắng lập chỉ mục. |
| Thêm hoặc hoàn tất task | ak plan add-phase, ak plan check | Tệp plan | Ghi Markdown của phase, sau đó cố gắng làm mới store row đã có. |
| Xem một thư mục | ak plan parse <path>, ak plan kanban [path] | Tệp plan | Đọc trực tiếp plan.md và phase-NN-*.md. |
| Liệt kê công việc đã theo dõi | ak plan list | Plan store, có fallback sang tệp | Đọc chỉ mục SQLite riêng tư; có thể fallback sang ./plans/ của repository hiện tại. |
| Đóng, lưu trữ hoặc dọn theo retention | ak plan close, ak plan archive, ak plan cleanup | Plan store | Đổi trạng thái vòng đời mà không xoá thư mục plan. |
| Nhập thư mục cũ | ak plan migrate --from-project-files | Tệp sang plan store | Xem trước hoặc lập chỉ mục các thư mục plan hợp lệ trong repository. |
| Quản lý một phase đã lập chỉ mục | ak plan phase | Tệp hoặc plan store, tuỳ lệnh con | Tách trạng thái do tệp sở hữu khỏi ghi chú và evidence chỉ có trong index. |
Tệp plan trong repository là nguồn chuẩn cho title, body, nội dung phase và
tiến độ suy ra từ checkbox. Store nằm tại
$AGENTKIT_HOME/plans/plans.db (mặc định ~/.agentkit/plans/plans.db) và lưu
định danh xuyên project, trạng thái vòng đời, trường chỉ có trong index và dữ
liệu tìm kiếm toàn văn.
Hiệu ứng cục bộ và quyền riêng tư
Nhóm plan không truy cập mạng, xác thực, gọi provider hay dùng cache từ xa.
Lệnh cần resolve định danh repository có thể chạy executable git cục bộ với
argument cố định. Lệnh dựa trên store có thể tạo thư mục/cơ sở dữ liệu plan riêng tư, siết quyền
truy cập và áp dụng migration schema chỉ tiến về phía trước khi mở store.
Đầu ra có cấu trúc có thể chứa URL repository, đường dẫn tuyệt đối tới project hoặc worktree, cũng như nội dung/title của plan. Hãy loại bỏ chi tiết cục bộ trước khi chia sẻ JSON ra ngoài máy.
Xác nhận và khôi phục
Không có một quy tắc xác nhận chung cho cả nhóm. Thao tác ghi tệp, close và
archive chạy trực tiếp. cleanup và migrate dùng cặp preview/apply rõ ràng.
--yes không thay thế cờ --apply bắt buộc của hai lệnh đó.
Close, archive và cleanup có apply giữ lại cơ sở dữ liệu khôi phục của plan
store. Chúng tách biệt với danh sách ak backups và không sao lưu tệp plan
trong repository. Hãy đọc trang của từng lệnh trước khi thay đổi một trong hai
lớp.
Kết quả và mã thoát
Chạy trợ giúp của lệnh cha thành công với mã 0. Cờ hoặc argument không hợp lệ
của lệnh cha dùng mã 2. Mã thoát thao tác phụ thuộc từng lệnh con; đừng xem
các dòng 1/2/3 chung trong trợ giúp lệnh cha là hợp đồng đầy đủ cho mọi
lệnh con.