דלג לתוכן הראשי

דרישות

  • Node.js >= 20.9.0
  • Bun >= 1.3.0 (אופציונלי - נדרש רק לבנייה מקוד)

התקנה

npm install -g failproofai

התחלה מהירה

1

הפעל מדיניויות

מדיניויות הן כללים שרצים לפני ואחרי כל קריאת כלי של אג’נט. הם תופסים פקודות הרסניות, דליפות סודיות, ודפוסי כשל אחרים לפני שהם גורמים נזק.
failproofai policies --install
פעולה זו כותבת ערכי hook לתוך ממשקי ה-CLI של אג’נט המותקנים (~/.claude/settings.json של Claude Code, ~/.codex/hooks.json של OpenAI Codex, ~/.copilot/hooks/failproofai.json של GitHub Copilot CLI, ~/.cursor/hooks.json של Cursor Agent, shim הפלאגין שנוצר של OpenCode ב-~/.config/opencode/plugins/failproofai.mjs בתוספת ערך רישום במערך plugin של ~/.config/opencode/opencode.json, ~/.pi/agent/settings.json של Pi, או ~/.gemini/settings.json של Gemini CLI). כאשר יותר מאחד קיים תתבקע בחירה; העבר --cli claude codex copilot cursor opencode pi gemini (כל תת-קבוצה) כדי לדלג על ההנחיה.תמיכה GitHub Copilot CLI, Cursor Agent, OpenCode, Pi ו-Gemini CLI היא beta — התקן עם --cli copilot, --cli cursor, --cli opencode, --cli pi, או --cli gemini.
failproofai policies --install --scope project
failproofai policies --install --cli codex --scope project
failproofai policies --install --cli copilot --scope project
failproofai policies --install --cli cursor --scope project
failproofai policies --install --cli opencode --scope project
failproofai policies --install --cli pi --scope project
failproofai policies --install --cli gemini --scope project
failproofai policies --install block-sudo block-rm-rf sanitize-api-keys
2

אמת

failproofai policies
מציג כל מדיניות, האם היא מופעלת, וכל פרמטר מוגדר.
3

הפעל את לוח המחוונים

failproofai
פותח לוח מחוונים מקומי ב-http://localhost:8020 שבו אתה יכול לעיין בהפעלות, לבדוק קריאות כלי, ולנהל מדיניויות.
4

הפעל את האג'נט שלך

הפעל את Claude Code כרגיל. אם האג’נט מנסה משהו סוכן, failproofai יחתוך אותו באופן אוטומטי. השאר אותו רץ ללא השגחה וסקור מה קרה בלוח המחוונים.

כיצד מדיניויות פועלות

בכל פעם שאג’נט מפעיל כלי, Claude Code קורא ל-failproofai כתהליך משנה:
Claude Code  →  failproofai --hook PreToolUse  →  קורא JSON מ-stdin
                                                    מעריך מדיניויות
                                                    כותב החלטה ל-stdout
כל מדיניות מחזירה אחת משלוש החלטות:
  • allow - האג’נט ממשיך כרגיל
  • deny - הפעולה חסומה, לאג’נט מסביר למה
  • instruct - הקשר נוסף מתווסף להנחיה של האג’נט
מדיניויות רצות בתהליך המקומי שלך. שום דבר לא נשלח לשירות מרחוק.

הגדר מדיניויות צוות עם מדיניויות מבוססות כנס

הדרך המהירה ביותר לכניסת סטנדרטים איכות על פני הצוות שלך היא כנס .failproofai/policies/. זרוק קובצי מדיניויות לתוך הספרייה הזו והם טעונים באופן אוטומטי — אין דגלים, אין שינויי תצורה, אין פקודות התקנה.
1

צור ספריית המדיניויות

mkdir -p .failproofai/policies
2

הוסף קובצי מדיניויות

העתק את דוגמאות ההתחלה או כתוב שלך:
cp node_modules/failproofai/examples/convention-policies/*.mjs .failproofai/policies/
או צור חדש:
// .failproofai/policies/team-policies.mjs
import { customPolicies, allow, deny, instruct } from "failproofai";

customPolicies.add({
  name: "test-before-commit",
  match: { events: ["PreToolUse"] },
  fn: async (ctx) => {
    if (ctx.toolName !== "Bash") return allow();
    if (/git\s+commit/.test(ctx.toolInput?.command ?? "")) {
      return instruct("הפעל בדיקות לפני התחייבות.");
    }
    return allow();
  },
});
3

התחייב ל-git

git add .failproofai/policies/
git commit -m "הוסף מדיניויות איכות צוות"
כל חברה בצוות שיש לה failproofai מותקנת בוחרת את המדיניויות הללו באופן אוטומטי. אין צורך בהגדרה לכל מפתח.
התחייב ל-.failproofai/policies/ למאגר שלך כדי שכל הצוות ישתף את אותם סטנדרטים. כאשר הצוות שלך מגלה דפוסי כשל חדשים, הוסף מדיניויות ודחוף — כולם מקבלים את העדכון בשלהם הבא git pull. עם הזמן מדיניויות אלה הופכות לסטנדרט איכות חי שממשיך להשתפר.

אחסון נתונים

כל התצורה והיומנים נשארים במכונה שלך:
נתיבמה הוא מאחסן
~/.failproofai/policies-config.jsonתצורת מדיניות גלובלית
~/.failproofai/hook-activity.jsonlהיסטוריית ביצוע Hook
~/.failproofai/hook.logיומן ניפוי לשגיאות hook מותאמות
.failproofai/policies-config.jsonתצורה לכל פרויקט (מחויבת)
.failproofai/policies-config.local.jsonהתעלמות אישית (gitignored)

הסרה

failproofai policies --uninstall
מסיר ערכי hook מ-~/.claude/settings.json. קובצי תצורה ב-~/.failproofai/ נשמרים.

שלבים הבאים

תצורה

הערכות וקובץ תצורה בפורמט

מדיניויות מובנות

כל 26 המדיניויות עם פרמטרים

מדיניויות מותאמות

כתוב מדיניויות שלך ב-JavaScript

צג אג'נט

עקוב אחר הפעלות וסקור פעילות מדיניויות