fp để kiểm tra telemetry của Cloud và quản lý audits, findings, issues, alerts, keys, users, queries và settings. Sử dụng failproofai cho local hooks, policies, capture và machine enrollment.
Cài đặt Cloud CLI phát hành dưới dạng công cụ riêng lẻ:
uv tool install fp-cli
fp version
Đăng nhập
fp login
fp whoami
Cú pháp
fp [GLOBAL_OPTIONS] COMMAND [SUBCOMMAND] [ARGUMENTS] [OPTIONS]
fp --json sessions --since 24h
fp COMMAND --help hoặc fp COMMAND SUBCOMMAND --help để xem trợ giúp trên terminal.
Các lệnh CLI
Xác thực
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp login | Đăng nhập bằng mã một lần được gửi qua email và chọn một tổ chức. | --email, -e; --org; --force |
fp logout | Thu hồi và xóa phiên người dùng đã lưu. | — |
fp whoami | Hiển thị danh tính hiện tại, chế độ xác thực, tổ chức và quyền hạn. | — |
fp version | Hiển thị phiên bản CLI đã cài đặt. | — |
fp help | Hiển thị trợ giúp lệnh cấp cao nhất. | — |
fp login --email you@example.com --org reliability-team
fp whoami
Sự kiện
fp events [OPTIONS]
--full cho một cuộc điều tra có giới hạn.
| Tùy chọn | Mô tả |
|---|---|
--limit, -n <n> | Tối đa tổng hàng. Mặc định: 50. |
--since <window> | all, 15m, 1h, 6h, 24h, hoặc 7d. |
--from <timestamp> / --to <timestamp> | Phạm vi ISO 8601 UTC; ghi đè --since. |
--env <value> | Bộ lọc môi trường; lặp lại hoặc phân tách bằng dấu phẩy. |
--event-type <value> | Bộ lọc loại sự kiện; lặp lại hoặc phân tách bằng dấu phẩy. |
--agent-id <value> | Bộ lọc agent; lặp lại hoặc phân tách bằng dấu phẩy. |
--session-id <value> | Bộ lọc phiên; lặp lại hoặc phân tách bằng dấu phẩy. |
--search <text> | Tìm kiếm văn bản payload; có thể lặp lại, bất kỳ thuật ngữ nào khớp. |
--order asc|desc | Thứ tự thời gian. Mặc định: mới nhất trước. |
--all | Tự động phân trang lên đến --limit. |
--cursor <token> | Tiếp tục từ một con trỏ mờ. |
--page-size <n> | Hàng trên mỗi yêu cầu với --all; tối đa 200. |
--full | Bao gồm raw payloads thông qua điểm cuối sự kiện nặng hơn. |
--fields <csv> | Chỉ trả về các trường được chọn; yêu cầu payload kích hoạt chế độ đầy đủ. |
fp events --session-id <session-id> --order asc --all
fp --json events --full --session-id <session-id> --all
Phiên
fp sessions [OPTIONS]
| Tùy chọn | Mô tả |
|---|---|
--limit, -n <n> | Tối đa tổng hàng. Mặc định: 50. |
--since <window> | all, 15m, 1h, 6h, 24h, hoặc 7d. |
--from <timestamp> / --to <timestamp> | Phạm vi ISO 8601 UTC; ghi đè --since. |
--env <value> | Bộ lọc môi trường; lặp lại hoặc phân tách bằng dấu phẩy. |
--status <value> | done, error, hoặc timeout; lặp lại hoặc phân tách bằng dấu phẩy. |
--agent-id <value> | Khớp các phiên liên quan đến bất kỳ agent được chọn nào. |
--session-id <value> | Bộ lọc phiên; lặp lại hoặc phân tách bằng dấu phẩy. |
--all | Tự động phân trang lên đến --limit. |
--cursor <token> | Tiếp tục từ một con trỏ mờ. |
--page-size <n> | Hàng trên mỗi yêu cầu với --all; tối đa 200. |
--fields <csv> | Chỉ trả về các trường được chọn. |
--full-ids | Không rút ngắn ID phiên trong đầu ra terminal. |
--agents | Mở rộng danh sách agent cho các phiên đa-agent. |
Đánh giá
fp evals [OPTIONS]
| Tùy chọn | Mô tả |
|---|---|
--aggregate | Hiển thị tổng cộng và thống kê theo điểm thay vì các đánh giá riêng lẻ. |
--limit, -n <n> | Tối đa hàng danh sách. Mặc định: 50. |
--since, --from, --to | Chọn phạm vi thời gian. |
--env, --status, --agent-id, --session-id | Thu hẹp thành một giá trị chính xác cho mỗi bộ lọc. |
--score KEY:MIN..MAX | Phạm vi điểm; có thể lặp lại và tất cả các phạm vi phải khớp. |
--all, --cursor, --page-size | Kiểm soát phân trang danh sách. |
--fields <csv> | Chỉ trả về các trường được chọn. |
--full-ids | Hiển thị ID phiên đầy đủ. |
--scores-full | Hiển thị mọi điểm trong đầu ra terminal. |
Lỗi
fp errors [OPTIONS]
| Tùy chọn | Mô tả |
|---|---|
--aggregate | Tóm tắt các lỗi phù hợp thay vì liệt kê hàng. |
--limit, -n <n> | Tối đa hàng danh sách. Mặc định: 50. |
--since, --from, --to | Chọn phạm vi thời gian. |
--env, --error-type, --event-type, --agent-id, --session-id | Thu hẹp dân số lỗi. |
--search <text> | Tìm kiếm văn bản payload; có thể lặp lại. |
--order asc|desc | Thứ tự thời gian. |
--all, --cursor, --page-size | Kiểm soát phân trang danh sách. |
--fields <csv> | Chỉ trả về các trường được chọn. |
--full-ids | Hiển thị ID phiên đầy đủ. |
Sử dụng và giá trị bộ lọc
| Lệnh | Mục đích |
|---|---|
fp usage | Hiển thị sử dụng cho cửa sổ đo lường hiện tại. |
fp list envs | Liệt kê các môi trường được quan sát. |
fp list agents | Liệt kê các ID agent được quan sát. |
fp list event_types | Liệt kê các loại sự kiện. |
fp list score_filters | Liệt kê các khóa điểm đánh giá. |
fp list models | Liệt kê các tên mô hình. |
fp list hooks | Liệt kê các tên hook. |
fp list tools | Liệt kê các tên công cụ. |
fp list error_types | Liệt kê các loại lỗi. |
Tổ chức
| Lệnh | Mục đích |
|---|---|
fp orgs list | Liệt kê các tổ chức có thể truy cập. |
fp orgs switch [SLUG] | Lưu một tổ chức hoạt động; nhắc khi bỏ qua. |
fp orgs current | Hiển thị tổ chức hoạt động. |
fp orgs perms | Hiển thị quyền hạn của bạn trong tổ chức hoạt động. |
Khóa API
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp keys list | Liệt kê các khóa tổ chức. | --show-id; --fields <csv> |
fp keys show NAME | Hiển thị một khóa và các quyền của nó. | — |
fp keys create NAME | Tạo một khóa và tiết lộ bí mật một lần. | --permission-set; --add; --remove |
fp keys update NAME | Thay thế bộ quyền hoặc điều chỉnh các quyền. | --permission-set; --add; --remove; --yes, -y |
fp keys regenerate NAME | Xoay bí mật và tiết lộ thay thế một lần. | --yes, -y |
fp keys disable NAME | Thu hồi vĩnh viễn một khóa. | --yes, -y |
resource:action, chẳng hạn như events:add. Lặp lại --add, phân tách bằng dấu phẩy hoặc sử dụng các hành động dấu chấm như events:read.add.
Truy vấn
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp query list | Liệt kê các truy vấn đã lưu. | --show-id; --fields <csv> |
fp query show NAME | Hiển thị một truy vấn. | — |
fp query create NAME | Lưu một truy vấn. | --sql <text|@file>; --description |
fp query update NAME | Cập nhật hoặc đổi tên một truy vấn. | --name; --sql; --description; --yes, -y |
fp query delete NAME | Xóa một truy vấn đã lưu. | --yes, -y |
fp query run [NAME] | Chạy một truy vấn đã lưu hoặc SQL ad-hoc. | --sql; --limit; --all; --arg, --param |
fp query schema [TABLE] | Liệt kê các bảng có thể truy vấn hoặc kiểm tra một bảng. | — |
Người dùng
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp users list | Liệt kê các thành viên tổ chức. | --active-only; --show-id |
fp users show EMAIL | Hiển thị một thành viên và các quyền của họ. | — |
fp users create EMAIL | Thêm một thành viên. | --permission-set; --add; --remove |
fp users update EMAIL | Thay đổi các quyền của một thành viên. | --permission-set; --add; --remove; --yes, -y |
fp users disable EMAIL | Vô hiệu hóa đăng nhập. | --yes, -y |
fp users enable EMAIL | Bật lại đăng nhập. | --yes, -y |
Cài đặt
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp settings list | Liệt kê các cài đặt tổ chức và giá trị hiện tại. | — |
fp settings schema | Hiển thị các giá trị được chấp nhận và mô tả. | — |
fp settings set KEY | Thay đổi một cài đặt hiện có. | chính xác một trong --value, --json-value, --file; --yes, -y tùy chọn |
Cảnh báo
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp alerts list | Liệt kê các quy tắc cảnh báo. | --show-id |
fp alerts show NAME | Hiển thị một cảnh báo. | — |
fp alerts create NAME | Tạo một cảnh báo. | --file; --description; --severity; --trigger-kind; --trigger-spec; --channels; --eval-interval-secs; --min-breaches; --eval-window |
fp alerts update NAME | Cập nhật hoặc đổi tên một cảnh báo. | tùy chọn tạo cộng với --name; --yes, -y |
fp alerts delete NAME | Xóa một cảnh báo. | --yes, -y |
fp alerts test NAME | Gửi một thông báo thử nghiệm. | --channels; --yes, -y |
info, warning và critical. Các loại kích hoạt là metric_threshold, custom_sql, evaluation_score, eval_compound và per_event. Các khoảng đánh giá phải nằm trong khoảng từ 30 đến 86.400 giây.
Kiểm toán
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp audits list | Liệt kê các kiểm toán. | --enabled-only; --show-id |
fp audits show NAME | Hiển thị một định nghĩa kiểm toán và trạng thái. | — |
fp audits create NAME | Tạo một kiểm toán và ngay lập tức xếp hàng chạy đầu tiên của nó. | Xem tùy chọn tạo. |
fp audits edit NAME | Thay thế cài đặt kiểm toán trong khi giữ lại các giá trị không được chỉ định. | tùy chọn định nghĩa tạo; --name; --yes, -y |
fp audits delete NAME | Xóa một kiểm toán, các findings của nó và lịch sử chạy. | --yes, -y |
fp audits run NAME | Xếp hàng một chạy thủ công. | — |
fp audits runs NAME | Liệt kê lịch sử chạy. | --limit, -n; --show-id |
fp audits context-show NAME | Hiển thị trang tóm tắt và trạng thái tìm nạp URL tham chiếu. | — |
fp audits context-set NAME | Thay đổi trang tóm tắt hoặc URL tham chiếu. | --text; --text-file; --url; --clear-urls |
fp audits context-refresh NAME | Tìm nạp lại URL tham chiếu. | — |
fp audits findings | Liệt kê các findings. | --audit; --run-id; --status; --limit, -n; --offset; --show-id |
fp audits finding FINDING_ID | Hiển thị một finding và các bằng chứng của nó. | — |
fp audits ack FINDING_ID | Xác nhận một finding. | --reason |
fp audits mute FINDING_ID | Chặn một mô hình lặp lại. | --reason; --yes, -y |
fp audits dismiss FINDING_ID | Đánh dấu một mô hình không thực hiện được hành động và chặn nó. | --reason; --yes, -y |
fp audits resolve FINDING_ID | Đánh dấu một finding đã sửa chữa mà không có sự chặn trong tương lai. | --yes, -y |
fp audits reopen FINDING_ID | Trả lại một finding vào hàng đợi trực tiếp và xóa các chặn. | — |
fp audits assign FINDING_ID | Đặt chủ sở hữu finding. | yêu cầu --to <email> |
Tùy chọn tạo kiểm toán
fp audits create checkout-reliability \
--description "Find checkout failures that agents do not recover from" \
--scope '{"environments":["production"],"agent_ids":["checkout-agent"]}' \
--schedule-interval-secs 86400 \
--window-mode since_last \
--sensitivity medium \
--text-file ./checkout-audit-brief.txt \
--url https://runbooks.example.com/checkout
| Tùy chọn | Mô tả |
|---|---|
--file <path> | Dựa trên định nghĩa JSON hoặc sử dụng - cho stdin. Các cờ rõ ràng ghi đè các giá trị tệp. |
--description <text> | Trình bày câu hỏi lỗi hoặc mục đích. |
--enabled / --disabled | Bắt đầu lên lịch hoặc tắt. Mặc định: bật. |
--schedule-interval-secs <n> | 3600–604800. Mặc định: 86400. |
--schedule-anchor <timestamp> | Giai đoạn UTC cố định ở dạng ISO 8601. Mặc định: tiếp theo 09:00 UTC. |
--window-mode since_last|fixed | Tiếp tục sau cửa sổ được phân tích đầy đủ cuối cùng hoặc kiểm tra lại cửa sổ lăn. Mặc định: since_last. |
--lookback-window-secs <n> | 3600–7776000. Mặc định: 604800. |
--scope '<json>' | Lọc theo environments, agent_ids hoặc các trường phạm vi được hỗ trợ khác. |
--ignore-error-type <type> | Loại trừ các loại lỗi; lặp lại hoặc phân tách bằng dấu phẩy. |
--llm / --no-llm | Bật hoặc tắt phân tích agent. Mặc định: bật. |
--top-k <n> | Giữ lại các findings 1–500. Mặc định: 50. |
--sensitivity low|medium|high | Đặt độ nhạy báo cáo. Mặc định: medium. |
--channels '<json>' | Mảng kênh thông báo. |
--text <brief> | Tóm tắt nội tuyến, tối đa 8.192 ký tự. |
--text-file <path> | Đọc tóm tắt từ một tệp; loại trừ lẫn nhau với --text. |
--url <https-url> | Thêm tham chiếu HTTPS công khai; lặp lại tối đa năm lần. |
fp audits run là không đồng bộ. Kiểm tra fp audits runs NAME cho đến khi chạy mới nhất thành công hoặc thất bại trước khi đọc các findings của nó.Sự cố
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp issues list | Liệt kê các sự cố. | --state; --alert-id; --limit, -n; --show-id |
fp issues count | Đếm các trạng thái vấn đề mở hoặc được chọn. | --state |
fp issues show INCIDENT_ID | Hiển thị chi tiết sự cố, nhận xét, người đăng ký và hoạt động. | — |
fp issues open | Mở một sự cố thủ công hoặc liên kết cảnh báo. | yêu cầu --summary; tùy chọn --title, --alert-id, --severity |
fp issues ack INCIDENT_ID | Xác nhận một sự cố. | — |
fp issues assign INCIDENT_ID | Thay thế những người được giao; bỏ qua tùy chọn để xóa. | --assignee có thể lặp lại |
fp issues resolve INCIDENT_ID | Giải quyết một sự cố. | --yes, -y |
fp issues comment-list INCIDENT_ID | Liệt kê nhận xét. | — |
fp issues comment-add INCIDENT_ID | Thêm nhận xét. | chính xác một trong --body, --file |
fp issues comment-delete INCIDENT_ID COMMENT_ID | Xóa nhận xét. | --yes, -y |
fp issues subscribers INCIDENT_ID | Liệt kê người đăng ký. | — |
fp issues subscribe INCIDENT_ID | Đăng ký chính bạn hoặc một toán tử khác. | --email |
fp issues unsubscribe INCIDENT_ID | Xóa đăng ký. | --email |
firing, acknowledged và resolved. Các mức độ nghiêm trọng sự cố độc lập là info, warning và critical.
Trợ lý Cloud
| Lệnh | Mục đích | Tùy chọn |
|---|---|---|
fp agent health | Kiểm tra sự sẵn có và cấu hình trợ lý. | — |
fp agent models | Liệt kê các mô hình trợ lý có sẵn. | — |
fp agent chats | Liệt kê các cuộc trò chuyện đã lưu. | — |
fp agent ask [MESSAGE] | Bắt đầu hoặc tiếp tục cuộc trò chuyện; đọc stdin khi bỏ qua tin nhắn. | --chat; --model; --page-context |
fp agent show CHAT_ID | Hiển thị một cuộc trò chuyện đã lưu. | — |
fp agent rename CHAT_ID | Đổi tên một cuộc trò chuyện. | yêu cầu --title |
fp agent delete CHAT_ID | Xóa một cuộc trò chuyện. | --yes, -y |
Cờ toàn cục
| Cờ | Mô tả |
|---|---|
--json | Phát ra JSON có thể đọc bằng máy. |
--base-url <url> | Sử dụng bảng điều khiển tự lưu trữ hoặc phát triển. |
--org <slug> | Chọn một tổ chức cho lệnh này. |
--token <token> | Ghi đè mã thông báo phiên người dùng đã lưu. |
--api-key <key> | Xác thực tự động bằng khóa API; không bao giờ được lưu. |
--timeout <seconds> | Hết thời gian HTTP; phải dương. Mặc định: 30. |
--quiet, -q | Chặn đầu ra trạng thái trên stderr. |
--no-color | Vô hiệu hóa đầu ra có màu. |
--insecure / --secure | Vô hiệu hóa hoặc khôi phục xác minh chứng chỉ TLS. |
--version | In phiên bản không được bao quanh và thoát. |
--help, -h | Hiển thị trợ giúp. |
--api-key được dự định cho tự động hóa. Đăng nhập, chuyển đổi tổ chức và các lệnh trợ lý yêu cầu một phiên người dùng.
Biến môi trường
| Biến | Tương đương hoặc mục đích |
|---|---|
AGENTEYE_DASHBOARD_URL | --base-url |
AGENTEYE_ORG | --org |
AGENTEYE_CLI_TOKEN | --token |
AGENTEYE_CLI_API_KEY | --api-key |
AGENTEYE_CLI_JSON | --json |
AGENTEYE_INSECURE | --insecure |
AGENTEYE_HOME | Chuyển vị trí thư mục cấu hình CLI hiện tại. |
AGENTEYE_ANALYTICS_DISABLED hoặc DO_NOT_TRACK | Vô hiệu hóa phân tích CLI ẩn danh. |
NO_COLOR | Vô hiệu hóa đầu ra có màu. |
--org hoặc AGENTEYE_ORG.
Các lệnh xóa, thu hồi, chặn, giải quyết hoặc thay thế cấu hình sẽ nhắc theo mặc định. Chỉ sử dụng
--yes sau khi xác minh tổ chức hoạt động và mục tiêu.