Tham chiếu
Quy ước CLI
Flag toàn cục, chế độ output và exit code chuẩn dùng chung cho mọi lệnh ak.
Mọi lệnh ak dùng chung một bộ quy ước về flag, output và exit code. Các trang
trong tham chiếu CLI chỉ liệt kê phần riêng của từng lệnh; mọi thứ
trên trang này áp dụng cho tất cả.
Flag toàn cục
| Flag | Mô tả |
|---|---|
--json | Xuất JSON máy đọc được (ngầm bật --no-interactive) |
--no-interactive | Tắt prompt tương tác (an toàn cho CI) |
-q, --quiet | Ẩn output không phải lỗi trên stderr |
-V, --verbose | Thêm output chẩn đoán trên stderr (thua --quiet) |
-y, --yes | Tự trả lời yes cho mọi prompt |
-h, --help | In hướng dẫn của lệnh |
Chế độ output
| Chế độ | Hành vi |
|---|---|
pretty | mặc định trên TTY (màu, ký hiệu ASCII) |
plain | tự chọn khi stdout bị pipe hoặc --no-interactive |
json | --json (một object duy nhất, an toàn NDJSON) |
Exit code
| Code | Ý nghĩa |
|---|---|
0 | thành công |
1 | lỗi runtime |
2 | flag không hợp lệ |
3 | người dùng hủy (SIGINT, hủy prompt) |
Mục Exit codes trên trang mỗi lệnh chỉ liệt kê code (hoặc ý nghĩa) mở rộng so với bộ chuẩn này.