תחילת עבודה

דרישות

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

התקנה

npm install -g failproofai

bun add -g failproofai

התחלה מהירה

הפעל מדיניות

מדיניות הן כללים שרצים לפני ואחרי כל קריאה לכלי סוכן. הם תופסים פקודות הורסות, דליפת סודות וטעויות אחרות לפני שהם גורמים לנזק.

failproofai policies --install

זה כותב ערכי hook ל-CLI של סוכנים מותקנים (Claude Code של ~/.claude/settings.json, OpenAI Codex של ~/.codex/hooks.json, GitHub Copilot CLI של ~/.copilot/hooks/failproofai.json, Cursor Agent של ~/.cursor/hooks.json, OpenCode של plugin shim שנוצר ב-~/.config/opencode/plugins/failproofai.mjs בתוספת ערך רישום במערך plugin של ~/.config/opencode/opencode.json, Pi של ~/.pi/agent/settings.json, או Hermes של ~/.hermes/config.yaml). כאשר יותר מאחד קיים תתבקע לבחור; העבר --cli claude codex copilot cursor opencode pi hermes (כל קבוצה משנית) כדי לדלג על ההודעה.תמיכה ב-GitHub Copilot CLI, Cursor Agent, OpenCode ו-Pi היא בטא — התקן עם --cli copilot, --cli cursor, --cli opencode, או --cli pi. Hermes (hermes-agent, שער Slack/Telegram) מותקן בטווח משתמש עם --cli hermes והוא גם מקור ביקורת לא מקוון.

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 hermes --scope user
failproofai policies --install block-sudo block-rm-rf sanitize-api-keys

אימות

failproofai policies

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

הפעל את לוח הבקרה

failproofai

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

הפעל את הסוכן שלך

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

איך מדיניות עובדת

בכל פעם שסוכן מפעיל כלי, Claude Code קורא ל-failproofai כתהליך משנה:

Claude Code  →  failproofai --hook PreToolUse  →  קורא JSON מ-stdin
                                                  מעריך מדיניות
                                                  כותב החלטה ל-stdout

כל מדיניות מחזירה אחת משלוש החלטות:

allow - הסוכן ממשיך כרגיל
deny - הפעולה נחסמת, לסוכן מובא הסבר
instruct - הקשר נוסף נוסף להנמקת הסוכן

מדיניות רצה בתהליך המקומי שלך. שום דבר לא נשלח לשירות מרחוק.

הגדר מדיניות של צוות עם מדיניות מבוססות קונבנציה

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

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

mkdir -p .failproofai/policies

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

העתק דוגמאות ההתחלה או כתוב את שלך:

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("הרץ בדיקות לפני ביצוע commit.");
    }
    return allow();
  },
});

בצע commit ל-git

git add .failproofai/policies/
git commit -m "הוסף מדיניות איכות של צוות"

כל חבר בצוות שיש לו failproofai מותקן יקבל את המדיניות הללו באופן אוטומטי. אין צורך בהגדרה לכל מפתח.

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

אחסון נתונים

כל תצורה ו-log נשארים במכונה שלך:

נתיב	מה זה שומר
`~/.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

צג סוכן

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