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
Mọi lệnh chạy được đều trả về cùng ba kết quả cơ bản:
| Code | Ý nghĩa |
|---|---|
0 | thành công |
1 | lệnh thất bại |
2 | flag hoặc tham số không hợp lệ |
Code 3 trở lên là riêng theo từng lệnh, và cùng một con số có thể mang ý
nghĩa khác nhau ở các lệnh khác nhau. Mục Exit codes trên trang mỗi lệnh
chỉ liệt kê những mã đó: 3 là người dùng hủy ở ak recover,
ak backups restore, ak setup và ak onboard, nhưng lại báo preview đã
hoàn tất ở các lệnh con ak analytics.