secrets
ak secrets annotate
Đặt hoặc xoá profile tìm kiếm của một secret đã lưu mà không đụng tới giá trị.
Dùng ak secrets annotate để mô tả một secret đã lưu: nó dùng để làm gì, thuộc
provider, môi trường và tài khoản nào, cùng các trường giúp agent chọn giữa các
credential ứng viên. Profile là metadata cho
ak secrets search và ak secrets describe;
nó không bao giờ là giá trị và không bao giờ là chỉ dẫn.
Cách dùng
ak secrets annotate <ref> [cờ profile] [--backend <backend>]Phải có đúng một ref, và phải truyền ít nhất một cờ profile. Cờ bỏ qua giữ
nguyên giá trị đang lưu; cờ truyền rỗng (--tag "") xoá trường đó; cờ dạng
danh sách thay thế toàn bộ danh sách.
| Cờ | Mô tả |
|---|---|
--description <text> | Secret dùng để làm gì. |
--project <name> | Project mà secret thuộc về; lặp lại hoặc phân cách bằng dấu phẩy cho nhiều project. |
--environment <name> | Môi trường, ví dụ production hoặc staging. |
--provider <name> | Dịch vụ mà secret dùng cho, ví dụ stripe hoặc openai. |
--account <name> | Tài khoản hoặc workspace tại provider. |
--tag <tag> | Tag; lặp lại hoặc phân cách bằng dấu phẩy cho nhiều tag. |
--kind <kind> | Một trong api_key, token, password, private_key, certificate, connection_string, webhook_secret, client_secret, other. |
--usage-host <host> | Host mà credential dành cho; lặp lại cho nhiều host. Chỉ là gợi ý định tuyến. |
--when-to-use <text> | Khi nào agent nên chọn credential này. |
--when-not-to-use <text> | Khi nào agent không được chọn credential này. |
--permission <perm> | Credential có thể làm gì tại provider, ví dụ read:orders; lặp lại cho nhiều quyền. Không được thực thi. |
--sensitivity <level> | normal hoặc high. Một nhãn theo cách gọi của giao thức sync; không gì thực thi nó. |
--alias <name> | Tên khác mà secret được biết tới; lặp lại cho nhiều tên. Chỉ dùng để tìm kiếm. |
--owner <text> | Người hoặc nhóm chịu trách nhiệm về credential. |
--expires-at <time> | Thời điểm credential phía provider hết hạn: thời gian RFC 3339 hoặc YYYY-MM-DD. |
--rotate-url <url> | Trang https nơi rotate credential; ak không bao giờ mở nó. |
--backend <backend> | Backend có index được cập nhật: keychain (mặc định), file hoặc memory. |
Mỗi trường ghi ở đây mang origin local, đánh dấu là tin cậy trong khi văn bản
import thì không. Không gì cấp quyền truy cập đọc profile: --permission,
--usage-host và --when-to-use là gợi ý, không phải ràng buộc.
Không bao giờ đặt giá trị secret vào profile. Văn bản được đối chiếu với fingerprint của các giá trị đã lưu và của các giá trị thiết bị này đã release, và bị từ chối khi chứa một trong số đó.
Lệnh cập nhật metadata của ref trong ~/.agentkit/secrets/index.json. Lệnh
không bao giờ mở backend hay thay đổi giá trị.
Đầu ra
Stdout cho người dùng in một dòng: annotated <ref> kèm tóm tắt ngắn của
profile, hoặc (no profile) khi mọi trường giờ đều rỗng.
JSON thành công dùng:
schema_version: 1
kind: secrets.annotate
data: metadata của ref sau khi sửadata mang ref, createdAt, rotatedAt khi có, source khi biết, và
profile, với mỗi trường là {value, origin, by, at}. Không có giá trị nào
được kèm theo.
Kết quả và mã thoát
| Mã thoát | Ý nghĩa |
|---|---|
0 | Thành công. |
2 | Cờ, argument hoặc metadata không hợp lệ, kể cả khi không truyền cờ profile nào hoặc văn bản chứa một giá trị đã lưu hay đã release. |
3 | Không tìm thấy ref. |
5 | Lỗi index, hoặc không đọc được release manifest để kiểm tra giá trị. |