शुरुआत करें

आवश्यकताएं

Node.js >= 20.9.0
Bun >= 1.3.0 (वैकल्पिक - केवल source से build करने के लिए आवश्यक)

इंस्टॉलेशन

npm install -g failproofai

bun add -g failproofai

त्वरित शुरुआत

Policies सक्षम करें

Policies वे नियम हैं जो प्रत्येक agent tool call से पहले और बाद में चलते हैं। वे destructive commands, secret leakage, और अन्य failure modes को नुकसान पहुंचाने से पहले रोक देते हैं।

failproofai policies --install

यह आपके installed agent CLIs में hook entries लिखता है (Claude Code का ~/.claude/settings.json, OpenAI Codex का ~/.codex/hooks.json, GitHub Copilot CLI का ~/.copilot/hooks/failproofai.json, Cursor Agent का ~/.cursor/hooks.json, OpenCode का generated plugin shim ~/.config/opencode/plugins/failproofai.mjs और ~/.config/opencode/opencode.json के plugin array में एक registration entry, Pi का ~/.pi/agent/settings.json, या Gemini CLI का ~/.gemini/settings.json)। जब एक से अधिक मौजूद हों तो आपसे पूछा जाएगा; prompt को छोड़ने के लिए --cli claude codex copilot cursor opencode pi gemini (किसी भी subset) पास करें।GitHub Copilot CLI, Cursor Agent, OpenCode, Pi, और Gemini CLI support 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

सत्यापित करें

failproofai policies

हर policy, चाहे वह सक्षम है या नहीं, और किसी भी configured parameters को दिखाता है।

Dashboard लॉन्च करें

failproofai

http://localhost:8020 पर एक local dashboard खोलता है जहां आप sessions browse कर सकते हैं, tool calls inspect कर सकते हैं, और policies manage कर सकते हैं।

अपने agent को चलाएं

Claude Code को सामान्य रूप से शुरू करें। अगर agent कुछ risky करने की कोशिश करता है, तो failproofai इसे स्वचालित रूप से intercept करता है। इसे unattended चलाएं और dashboard में समीक्षा करें कि क्या हुआ।

Policies कैसे काम करती हैं

जब भी एक agent एक tool चलाता है, Claude Code failproofai को एक subprocess के रूप में कॉल करता है:

Claude Code  →  failproofai --hook PreToolUse  →  stdin JSON पढ़ता है
                                                 policies का मूल्यांकन करता है
                                                 stdout को decision लिखता है

प्रत्येक policy तीन decisions में से एक लौटाता है:

allow - agent सामान्य रूप से आगे बढ़ता है
deny - action को block किया जाता है, agent को बताया जाता है कि क्यों
instruct - extra context agent के prompt में जोड़ा जाता है

Policies आपकी local process में चलती हैं। कुछ भी किसी remote service को नहीं भेजा जाता है।

Convention-based policies के साथ team policies सेट अप करें

अपनी team में quality standards स्थापित करने का सबसे तेज़ तरीका .failproofai/policies/ convention है। इस directory में policy files डालें और वे स्वचालित रूप से load हो जाते हैं — कोई flags नहीं, कोई config changes नहीं, कोई install commands नहीं।

Policies directory बनाएं

mkdir -p .failproofai/policies

Policy files जोड़ें

Starter examples copy करें या अपने स्वयं के बनाएं:

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 से पहले tests चलाएं।");
    }
    return allow();
  },
});

Git को commit करें

git add .failproofai/policies/
git commit -m "Team quality policies जोड़ें"

हर team member जिसके पास failproofai इंस्टॉल है ये policies स्वचालित रूप से उठाता है। कोई per-developer setup की आवश्यकता नहीं है।

अपने repo में .failproofai/policies/ commit करें ताकि पूरी team एक ही standards share करे। जैसे-जैसे आपकी team नए failure modes की खोज करती है, policies जोड़ें और push करें — हर किसी को अपने अगले git pull पर update मिल जाता है। समय के साथ ये policies एक living quality standard बन जाती हैं जो likepostulate में सुधार होता रहता है।

Data storage

सभी configuration और logs आपकी machine पर रहते हैं:

Path	क्या store किया जाता है
`~/.failproofai/policies-config.json`	Global policy config
`~/.failproofai/hook-activity.jsonl`	Hook execution history
`~/.failproofai/hook.log`	Custom hook errors के लिए debug log
`.failproofai/policies-config.json`	Per-project config (committed)
`.failproofai/policies-config.local.json`	Personal overrides (gitignored)

Uninstalling

failproofai policies --uninstall

~/.claude/settings.json से hook entries को remove करता है। ~/.failproofai/ में config files को रखा जाता है।

अगले कदम

Configuration

Scopes और config file format

Built-in policies

सभी 26 policies with parameters

Custom policies

JavaScript में अपनी स्वयं की policies लिखें

Agent monitor

Sessions को monitor करें और policy activity की समीक्षा करें

शुरू करें

मूल अवधारणाएँ

CLI

उपकरण

उन्नत

शुरुआत करें

आवश्यकताएं

इंस्टॉलेशन

त्वरित शुरुआत

Policies कैसे काम करती हैं

Convention-based policies के साथ team policies सेट अप करें

Data storage

Uninstalling

अगले कदम

Configuration

Built-in policies

Custom policies

Agent monitor

​आवश्यकताएं

​इंस्टॉलेशन

​त्वरित शुरुआत

​Policies कैसे काम करती हैं

​Convention-based policies के साथ team policies सेट अप करें

​Data storage

​Uninstalling

​अगले कदम

Configuration

Built-in policies

Custom policies

Agent monitor

आवश्यकताएं

इंस्टॉलेशन

त्वरित शुरुआत

Policies कैसे काम करती हैं

Convention-based policies के साथ team policies सेट अप करें

Data storage

Uninstalling

अगले कदम