Chuyển đến nội dung chính
Các chính sách tùy chỉnh cho phép bạn viết các quy tắc cho bất kỳ hành vi nào của agent: thực thi quy ước dự án, ngăn chặn sự trôi dạt, kiểm soát các hoạt động phá hủy, phát hiện các agent bị mắc kẹt, hoặc tích hợp với Slack, quy trình phê duyệt, v.v. Chúng sử dụng cùng một hệ thống sự kiện hook và các quyết định allow, deny, instruct như các chính sách có sẵn.

Ví dụ nhanh

Cài đặt nó:

Hai cách để tải các chính sách tùy chỉnh

Tùy chọn 1: Dựa trên quy ước (được khuyến nghị)

Thả các tệp *policies.{js,mjs,ts} vào .failproofai/policies/ và chúng sẽ được tải tự động — không cần các cờ hoặc thay đổi cấu hình. Điều này hoạt động như git hooks: thả một tệp, nó chỉ hoạt động.
Cách nó hoạt động:
  • Cả hai thư mục dự án và người dùng được quét (hợp nhất — không phải chiến thắng phạm vi đầu tiên)
  • Các tệp được tải theo thứ tự bảng chữ cái trong mỗi thư mục. Thêm tiền tố 01-, 02- để kiểm soát thứ tự
  • Chỉ các tệp khớp với *policies.{js,mjs,ts} được tải; các tệp khác bị bỏ qua
  • Mỗi tệp được tải độc lập (mở lỗi cho mỗi tệp)
  • Hoạt động cùng với các chính sách --custom rõ ràng và có sẵn
Các chính sách quy ước là cách dễ nhất để xây dựng tiêu chuẩn chất lượng cho tổ chức của bạn. Cam kết .failproofai/policies/ vào git và mỗi thành viên trong nhóm sẽ tự động nhận các quy tắc giống nhau — không cần thiết lập cho mỗi nhà phát triển. Khi nhóm của bạn phát hiện ra các chế độ lỗi mới, hãy thêm một chính sách và đẩy. Theo thời gian, những điều này trở thành một tiêu chuẩn chất lượng sống động tiếp tục cải thiện với mỗi đóng góp.

Tùy chọn 2: Đường dẫn tệp rõ ràng

Đường dẫn tuyệt đối được giải quyết được lưu trữ trong policies-config.json dưới dạng customPoliciesPath. Tệp được tải mới trên mỗi sự kiện hook - không có bộ nhớ đệm giữa các sự kiện.

Sử dụng cả hai cùng nhau

Các chính sách quy ước và tệp --custom rõ ràng có thể coexist. Thứ tự tải:
  1. Tệp customPoliciesPath rõ ràng (nếu được cấu hình)
  2. Các tệp quy ước dự án ({cwd}/.failproofai/policies/, theo thứ tự bảng chữ cái)
  3. Các tệp quy ước người dùng (~/.failproofai/policies/, theo thứ tự bảng chữ cái)

API

Nhập khẩu

customPolicies.add(hook)

Đăng ký một chính sách. Gọi điều này bao nhiêu lần cần thiết cho nhiều chính sách trong cùng một tệp.

Các trợ giúp quyết định

deny(message) - thông báo xuất hiện trước Claude với tiền tố "Blocked by failproofai:". Một deny duy nhất sẽ ngắn mạch tất cả các đánh giá tiếp theo. instruct(message) - thông báo được thêm vào ngữ cảnh của Claude cho lệnh gọi công cụ hiện tại. Tất cả các thông báo instruct được tích lũy và được gửi cùng nhau.
Bạn có thể thêm hướng dẫn bổ sung vào bất kỳ thông báo deny hoặc instruct nào bằng cách thêm trường hint trong policyParams — không cần thay đổi mã. Điều này hoạt động cho các chính sách tùy chỉnh (custom/), quy ước dự án (.failproofai-project/), và quy ước người dùng (.failproofai-user/) cũng vậy. Xem Cấu hình → hint để biết chi tiết.

Các thông báo allow có thông tin

allow(message) cho phép hoạt động gửi lại một thông báo thông tin cho Claude. Thông báo được gửi dưới dạng additionalContext trong phản hồi stdout của trình xử lý hook — cơ chế giống như được sử dụng bởi instruct, nhưng có nghĩa khác: nó là một cập nhật trạng thái, không phải cảnh báo. Các trường hợp sử dụng:
  • Xác nhận trạng thái: allow("All CI checks passed.") — cho Claude biết mọi thứ đều tốt
  • Giải thích mở lỗi: allow("GitHub CLI not installed, skipping CI check.") — cho Claude biết lý do tại sao kiểm tra bị bỏ qua để nó có đầy đủ ngữ cảnh
  • Nhiều thông báo tích lũy: nếu nhiều chính sách mỗi cái trả về allow(message), tất cả các thông báo được nối với dòng mới và gửi cùng nhau

Các trường PolicyContext

Các trường SessionMetadata

Các loại sự kiện


Thứ tự đánh giá

Các chính sách được đánh giá theo thứ tự này:
  1. Các chính sách có sẵn (theo thứ tự định nghĩa)
  2. Các chính sách tùy chỉnh rõ ràng từ customPoliciesPath (theo thứ tự .add())
  3. Các chính sách quy ước từ dự án .failproofai/policies/ (tệp theo thứ tự bảng chữ cái, thứ tự .add() bên trong)
  4. Các chính sách quy ước từ người dùng ~/.failproofai/policies/ (tệp theo thứ tự bảng chữ cái, thứ tự .add() bên trong)
deny đầu tiên sẽ ngắn mạch tất cả các chính sách tiếp theo. Tất cả các thông báo instruct được tích lũy và được gửi cùng nhau.

Nhập bắc cầu

Các tệp chính sách tùy chỉnh có thể nhập các mô-đun cục bộ bằng cách sử dụng các đường dẫn tương đối:
Tất cả các nhập bắc cầu có thể truy cập được từ tệp mục nhập được giải quyết. Điều này được triển khai bằng cách viết lại các nhập from "failproofai" sang đường dẫn dist thực tế và tạo các tệp .mjs tạm thời để đảm bảo tương thích ESM.

Lọc loại sự kiện

Sử dụng match.events để giới hạn khi chính sách xảy ra:
Bỏ qua match hoàn toàn để xảy ra trên mỗi loại sự kiện.

Xử lý lỗi và các chế độ lỗi

Các chính sách tùy chỉnh mở lỗi: các lỗi không bao giờ chặn các chính sách có sẵn hoặc làm hỏng trình xử lý hook.
Để gỡ lỗi các lỗi chính sách tùy chỉnh, hãy theo dõi tệp nhật ký:

Ví dụ đầy đủ: nhiều chính sách


Ví dụ

Thư mục examples/ chứa các tệp chính sách sẵn sàng để chạy:

Sử dụng các ví dụ tệp rõ ràng

Sử dụng các ví dụ dựa trên quy ước

Không cần lệnh cài đặt — các tệp được nhặt lên tự động trên sự kiện hook tiếp theo.