failproofai 0.0.2 → 0.0.4-beta.0

package/.next/standalone/docs/hi/testing.mdx

@@ -0,0 +1,260 @@
+---
+title: परीक्षण
+description: "यूनिट टेस्ट, E2E टेस्ट, और टेस्ट हेल्पर्स"
+icon: flask-vial
+---
+
+failproofai के दो टेस्ट सूट हैं: **यूनिट टेस्ट** (तेज़, मॉक किए गए) और **एंड-टू-एंड टेस्ट** (वास्तविक सबप्रोसेस आमंत्रण)।
+
+---
+
+## टेस्ट चलाना
+
+```bash
+# सभी यूनिट टेस्ट एक बार चलाएं
+bun run test:run
+
+# यूनिट टेस्ट को वॉच मोड में चलाएं
+bun run test
+
+# E2E टेस्ट चलाएं (सेटअप की आवश्यकता है - नीचे देखें)
+bun run test:e2e
+
+# बिल्ड किए बिना टाइप-चेक करें
+bunx tsc --noEmit
+
+# लिंट करें
+bun run lint
+```
+
+---
+
+## यूनिट टेस्ट
+
+यूनिट टेस्ट `__tests__/` में रहते हैं और [Vitest](https://vitest.dev) के साथ `happy-dom` का उपयोग करते हैं।
+
+```text
+__tests__/
+  hooks/
+    builtin-policies.test.ts      # प्रत्येक बिल्टइन के लिए पॉलिसी लॉजिक
+    hooks-config.test.ts          # कॉन्फ़िग लोडिंग और स्कोप मर्जिंग
+    policy-evaluator.test.ts      # पैरम इंजेक्शन और मूल्यांकन क्रम
+    custom-hooks-registry.test.ts # globalThis रजिस्ट्री add/get/clear
+    custom-hooks-loader.test.ts   # ESM लोडर, ट्रांजिटिव इम्पोर्ट, त्रुटि प्रबंधन
+    manager.test.ts               # install/remove/list ऑपरेशन
+  components/
+    sessions-list.test.tsx        # सेशन लिस्ट कंपोनेंट
+    project-list.test.tsx         # प्रोजेक्ट लिस्ट कंपोनेंट
+    ...
+  lib/
+    logger.test.ts
+    paths.test.ts
+    date-filters.test.ts
+    telemetry.test.ts
+    ...
+  actions/
+    get-hooks-config.test.ts
+    get-hook-activity.test.ts
+    ...
+  contexts/
+    ThemeContext.test.tsx
+    AutoRefreshContext.test.tsx
+```
+
+### पॉलिसी यूनिट टेस्ट लिखना
+
+```typescript
+import { describe, it, expect, beforeEach } from "vitest";
+import { getBuiltinPolicies } from "../../src/hooks/builtin-policies";
+import { allow, deny } from "../../src/hooks/policy-types";
+
+describe("block-sudo", () => {
+  const policy = getBuiltinPolicies().find((p) => p.name === "block-sudo")!;
+
+  it("denies sudo commands", () => {
+    const ctx = {
+      eventType: "PreToolUse" as const,
+      payload: {},
+      toolName: "Bash",
+      toolInput: { command: "sudo apt install nodejs" },
+      params: { allowPatterns: [] },
+    };
+    expect(policy.fn(ctx)).toEqual(deny("sudo command blocked by failproofai"));
+  });
+
+  it("allows non-sudo commands", () => {
+    const ctx = {
+      eventType: "PreToolUse" as const,
+      payload: {},
+      toolName: "Bash",
+      toolInput: { command: "ls -la" },
+      params: { allowPatterns: [] },
+    };
+    expect(policy.fn(ctx)).toEqual(allow());
+  });
+
+  it("allows patterns in allowPatterns", () => {
+    const ctx = {
+      eventType: "PreToolUse" as const,
+      payload: {},
+      toolName: "Bash",
+      toolInput: { command: "sudo systemctl status nginx" },
+      params: { allowPatterns: ["sudo systemctl status"] },
+    };
+    expect(policy.fn(ctx)).toEqual(allow());
+  });
+});
+```
+
+---
+
+## एंड-टू-एंड टेस्ट
+
+E2E टेस्ट वास्तविक `failproofai` बाइनरी को सबप्रोसेस के रूप में आमंत्रित करते हैं, stdin को JSON पेलोड पाइप करते हैं, और stdout आउटपुट और एक्जिट कोड पर दावे लगाते हैं। यह पूर्ण इंटीग्रेशन पथ का परीक्षण करता है जो Claude Code उपयोग करता है।
+
+### सेटअप
+
+E2E टेस्ट बाइनरी को रेपो सोर्स से सीधे चलाते हैं। पहली बार चलाने से पहले, CJS बंडल बनाएं जो कस्टम हुक फाइलें `'failproofai'` से इम्पोर्ट करते समय उपयोग करती हैं:
+
+```bash
+bun build src/index.ts --outdir dist --target node --format cjs
+```
+
+फिर टेस्ट चलाएं:
+
+```bash
+bun run test:e2e
+```
+
+जब भी आप सार्वजनिक हुक API (`src/hooks/custom-hooks-registry.ts`, `src/hooks/policy-helpers.ts`, या `src/hooks/policy-types.ts`) में बदलाव करें तो `dist/` को फिर से बनाएं।
+
+### E2E टेस्ट संरचना
+
+```text
+__tests__/e2e/
+  helpers/
+    hook-runner.ts      # बाइनरी स्पॉन करें, पेलोड JSON पाइप करें, एक्जिट कोड + stdout + stderr कैप्चर करें
+    fixture-env.ts      # कॉन्फ़िग फाइलों के साथ प्रति-टेस्ट अलग-थलग अस्थायी निर्देशिकाएं
+    payloads.ts         # प्रत्येक इवेंट टाइप के लिए Claude-सटीक पेलोड फैक्ट्रीज़
+  hooks/
+    builtin-policies.e2e.test.ts   # वास्तविक सबप्रोसेस के साथ प्रत्येक बिल्टइन पॉलिसी
+    custom-hooks.e2e.test.ts       # कस्टम हुक लोडिंग और मूल्यांकन
+    config-scopes.e2e.test.ts      # प्रोजेक्ट/स्थानीय/वैश्विक में कॉन्फ़िग मर्जिंग
+    policy-params.e2e.test.ts      # प्रत्येक पैरामीटराइज्ड पॉलिसी के लिए पैरामीटर इंजेक्शन
+```
+
+### E2E हेल्पर्स का उपयोग करना
+
+**`FixtureEnv`** - प्रति-टेस्ट अलग-थलग वातावरण:
+
+```typescript
+import { createFixtureEnv } from "../helpers/fixture-env";
+
+const env = createFixtureEnv();
+// env.cwd    - अस्थायी निर्देशिका; .failproofai/policies-config.json पिक अप करने के लिए payload.cwd के रूप में पास करें
+// env.home   - अलग-थलग होम निर्देशिका; कोई वास्तविक ~/.failproofai लीक नहीं
+
+env.writeConfig({
+  enabledPolicies: ["block-sudo"],
+  policyParams: {
+    "block-sudo": { allowPatterns: ["sudo systemctl status"] },
+  },
+});
+```
+
+`createFixtureEnv()` स्वचालित रूप से `afterEach` क्लीनअप पंजीकृत करता है।
+
+**`runHook`** - बाइनरी को आमंत्रित करें:
+
+```typescript
+import { runHook } from "../helpers/hook-runner";
+import { Payloads } from "../helpers/payloads";
+
+const result = await runHook(
+  "PreToolUse",
+  Payloads.preToolUse.bash("sudo apt install nodejs", env.cwd),
+  { homeDir: env.home }
+);
+
+expect(result.exitCode).toBe(0);
+expect(result.parsed?.hookSpecificOutput?.permissionDecision).toBe("deny");
+```
+
+**`Payloads`** - तैयार पेलोड फैक्ट्रीज़:
+
+```typescript
+Payloads.preToolUse.bash(command, cwd)
+Payloads.preToolUse.write(filePath, content, cwd)
+Payloads.preToolUse.read(filePath, cwd)
+Payloads.postToolUse.bash(command, output, cwd)
+Payloads.postToolUse.read(filePath, content, cwd)
+Payloads.notification(message, cwd)
+Payloads.stop(cwd)
+```
+
+### E2E टेस्ट लिखना
+
+```typescript
+import { describe, it, expect } from "vitest";
+import { createFixtureEnv } from "../helpers/fixture-env";
+import { runHook } from "../helpers/hook-runner";
+import { Payloads } from "../helpers/payloads";
+
+describe("block-rm-rf (E2E)", () => {
+  it("denies rm -rf", async () => {
+    const env = createFixtureEnv();
+    env.writeConfig({ enabledPolicies: ["block-rm-rf"] });
+
+    const result = await runHook(
+      "PreToolUse",
+      Payloads.preToolUse.bash("rm -rf /", env.cwd),
+      { homeDir: env.home }
+    );
+
+    expect(result.exitCode).toBe(0);
+    expect(result.parsed?.hookSpecificOutput?.permissionDecision).toBe("deny");
+  });
+
+  it("allows non-recursive rm", async () => {
+    const env = createFixtureEnv();
+    env.writeConfig({ enabledPolicies: ["block-rm-rf"] });
+
+    const result = await runHook(
+      "PreToolUse",
+      Payloads.preToolUse.bash("rm /tmp/file.txt", env.cwd),
+      { homeDir: env.home }
+    );
+
+    expect(result.exitCode).toBe(0);
+    expect(result.stdout).toBe("");  // allow → empty stdout
+  });
+});
+```
+
+### E2E प्रतिक्रिया आकार
+
+| निर्णय | एक्जिट कोड | stdout |
+|----------|-----------|--------|
+| `PreToolUse` deny | `0` | `{"hookSpecificOutput":{"permissionDecision":"deny","permissionDecisionReason":"..."}}` |
+| `PostToolUse` deny | `0` | `{"hookSpecificOutput":{"additionalContext":"Blocked ... because: ..."}}` |
+| Instruct (गैर-Stop) | `0` | `{"hookSpecificOutput":{"additionalContext":"Instruction from failproofai: ..."}}` |
+| Stop instruct | `2` | खाली stdout; stderr में कारण |
+| Allow | `0` | खाली स्ट्रिंग |
+
+### Vitest कॉन्फ़िग
+
+E2E टेस्ट `vitest.config.e2e.mts` का उपयोग करते हैं:
+
+- `environment: "node"` - कोई ब्राउजर ग्लोबल्स की आवश्यकता नहीं
+- `pool: "forks"` - सच्चा प्रोसेस इसोलेशन (टेस्ट सबप्रोसेस स्पॉन करते हैं)
+- `testTimeout: 20_000` - प्रति टेस्ट 20 सेकंड (बाइनरी स्टार्टअप + हुक eval)
+
+`forks` पूल महत्वपूर्ण है: थ्रेड-आधारित वर्कर्स `globalThis` साझा करते हैं, जो सबप्रोसेस-स्पॉनिंग टेस्ट में हस्तक्षेप कर सकता है। प्रोसेस-आधारित फोर्क इससे बचते हैं।
+
+---
+
+## CI
+
+पूर्ण CI रन (`bun run lint && bunx tsc --noEmit && bun run test:run && bun run build`) मर्ज करने से पहले पास होना आवश्यक है। E2E सूट समानांतर में एक अलग CI जॉब के रूप में चलता है।
+
+पूर्ण प्री-मर्ज चेकलिस्ट के लिए [Contributing](../CONTRIBUTING.md) देखें।

package/.next/standalone/docs/i18n/README.ar.md

@@ -0,0 +1,312 @@
+> **⚠️** هذه ترجمة آلية. للاطلاع على أحدث إصدار، راجع [English README](../../README.md).
+
+[🇺🇸 English](../../README.md) | [🇨🇳 简体中文](README.zh.md) | [🇯🇵 日本語](README.ja.md) | [🇰🇷 한국어](README.ko.md) | [🇪🇸 Español](README.es.md) | [🇧🇷 Português](README.pt-br.md) | [🇩🇪 Deutsch](README.de.md) | [🇫🇷 Français](README.fr.md) | [🇷🇺 Русский](README.ru.md) | [🇮🇳 हिन्दी](README.hi.md) | [🇹🇷 Türkçe](README.tr.md) | [🇻🇳 Tiếng Việt](README.vi.md) | [🇮🇹 Italiano](README.it.md) | **🇸🇦 العربية** | [🇮🇱 עברית](README.he.md)
+
+---
+<div dir="rtl">
+
+
+```
+    ______      _ __                       ____   ___    ____
+   / ____/___ _(_) /___  _________  ____  / __/  /   |  /  _/
+  / /_  / __ `/ / / __ \/ ___/ __ \/ __ \/ /_   / /| |  / /
+ / __/ / /_/ / / / /_/ / /  / /_/ / /_/ / __/  / ___ |_/ /
+/_/    \__,_/_/_/ .___/_/   \____/\____/_/    /_/  |_/___/
+               /_/
+```
+
+# Failproof AI
+
+[![Docs](https://img.shields.io/badge/docs-befailproof.ai-002CA7?style=flat-square)](https://befailproof.ai)
+[![npm](https://img.shields.io/npm/v/failproofai?style=flat-square&color=CB3837)](https://www.npmjs.com/package/failproofai)
+[![License](https://img.shields.io/badge/license-MIT%20%2B%20Commons%20Clause-blue?style=flat-square)](LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/exospherehost/failproofai/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/exospherehost/failproofai/actions)
+[![Slack](https://img.shields.io/badge/Slack-join%20us-4A154B?style=flat-square&logo=slack)](https://join.slack.com/t/failproofai/shared_invite/zt-3v63b7k5e-O3NBHmj8X6n9gZSGDx6ggQ)
+
+**الترجمات**: [简体中文](docs/i18n/README.zh.md) | [日本語](docs/i18n/README.ja.md) | [한국어](docs/i18n/README.ko.md) | [Español](docs/i18n/README.es.md) | [Português](docs/i18n/README.pt-br.md) | [Deutsch](docs/i18n/README.de.md) | [Français](docs/i18n/README.fr.md) | [Русский](docs/i18n/README.ru.md) | [हिन्दी](docs/i18n/README.hi.md) | [Türkçe](docs/i18n/README.tr.md) | [Tiếng Việt](docs/i18n/README.vi.md) | [Italiano](docs/i18n/README.it.md) | [العربية](docs/i18n/README.ar.md) | [עברית](docs/i18n/README.he.md)
+
+أسهل طريقة لإدارة السياسات التي تجعل وكلاءك الذكيين موثوقين وملتزمين بالمهام ويعملون بشكل مستقل - لـ **Claude Code** و **Agents SDK**.
+
+- **30 سياسة مدمجة** - اكتشف أنماط فشل الوكيل الشائعة مباشرة من الصندوق. احجب الأوامر المدمرة، ومنع تسرب الأسرار، واحتفظ بالوكلاء داخل حدود المشروع، واكتشف الحلقات، والمزيد.
+- **سياسات مخصصة** - اكتب قواعد الموثوقية الخاصة بك في JavaScript. استخدم واجهات برمجية `allow`/`deny`/`instruct` لفرض الاتفاقيات، ومنع الانجراف، وتقييد العمليات، أو الدمج مع الأنظمة الخارجية.
+- **تكوين سهل** - اضبط أي سياسة بدون كتابة أكواد. حدد قوائم السماح والفروع المحمية والحدود الدنيا لكل مشروع أو عام. يتم دمج ثلاث نطاقات للتكوين تلقائياً.
+- **مراقب الوكيل** - اطلع على ما فعله وكلاؤك أثناء غيابك. تصفح الجلسات، وافحص كل استدعاء أداة، وراجع بالضبط حيث تم تفعيل السياسات.
+
+كل شيء يعمل محلياً - لا تترك البيانات جهازك.
+
+---
+
+## المتطلبات
+
+- Node.js >= 20.9.0
+- Bun >= 1.3.0 (اختياري - مطلوب فقط للتطوير / البناء من المصدر)
+
+---
+
+## التثبيت
+
+```bash
+npm install -g failproofai
+# أو
+bun add -g failproofai
+```
+
+---
+
+## البدء السريع
+
+### 1. تفعيل السياسات عالمياً
+
+```bash
+failproofai policies --install
+```
+
+يكتب إدخالات الخطاف في `~/.claude/settings.json`. سيقوم Claude Code الآن باستدعاء failproofai قبل وبعد كل استدعاء أداة.
+
+### 2. تشغيل لوحة التحكم
+
+```bash
+failproofai
+```
+
+يفتح `http://localhost:8020` - تصفح الجلسات، وافحص السجلات، وأدر السياسات.
+
+### 3. تحقق مما هو نشط
+
+```bash
+failproofai policies
+```
+
+---
+
+## تثبيت السياسة
+
+### النطاقات
+
+| النطاق | الأمر | المكان الذي تكتب فيه |
+|-------|---------|-----------------|
+| عام (افتراضي) | `failproofai policies --install` | `~/.claude/settings.json` |
+| المشروع | `failproofai policies --install --scope project` | `.claude/settings.json` |
+| محلي | `failproofai policies --install --scope local` | `.claude/settings.local.json` |
+
+### تثبيت سياسات معينة
+
+```bash
+failproofai policies --install block-sudo block-rm-rf sanitize-api-keys
+```
+
+### إزالة السياسات
+
+```bash
+failproofai policies --uninstall
+# أو لنطاق معين:
+failproofai policies --uninstall --scope project
+```
+
+---
+
+## التكوين
+
+يوجد تكوين السياسة في `~/.failproofai/policies-config.json` (عام) أو `.failproofai/policies-config.json` في مشروعك (لكل مشروع).
+
+```json
+{
+  "enabledPolicies": [
+    "block-sudo",
+    "block-rm-rf",
+    "sanitize-api-keys",
+    "block-push-master",
+    "block-env-files",
+    "block-read-outside-cwd"
+  ],
+  "policyParams": {
+    "block-sudo": {
+      "allowPatterns": ["sudo systemctl status", "sudo journalctl"],
+      "hint": "Use apt-get directly without sudo."
+    },
+    "block-push-master": {
+      "protectedBranches": ["main", "release", "prod"],
+      "hint": "Try creating a fresh branch instead."
+    },
+    "sanitize-api-keys": {
+      "additionalPatterns": [
+        { "regex": "myco_[A-Za-z0-9]{32}", "label": "MyCo API key" }
+      ]
+    },
+    "warn-large-file-write": {
+      "thresholdKb": 512
+    }
+  }
+}
+```
+
+**يتم دمج ثلاث نطاقات للتكوين** تلقائياً (المشروع → المحلي → العام). انظر [docs/configuration.mdx](docs/configuration.mdx) للحصول على قواعد الدمج الكاملة.
+
+---
+
+## السياسات المدمجة
+
+| السياسة | الوصف | قابل للتخصيص |
+|--------|-------------|:---:|
+| `block-sudo` | منع الوكلاء من تشغيل أوامر النظام المميزة | `allowPatterns` |
+| `block-rm-rf` | منع حذف الملفات العودي العرضي | `allowPaths` |
+| `block-curl-pipe-sh` | منع الوكلاء من نقل البرامج النصية غير الموثوقة إلى shell | |
+| `block-failproofai-commands` | منع إلغاء التثبيت الذاتي | |
+| `sanitize-jwt` | إيقاف تسرب رموز JWT إلى سياق الوكيل | |
+| `sanitize-api-keys` | إيقاف تسرب مفاتيح API إلى سياق الوكيل | `additionalPatterns` |
+| `sanitize-connection-strings` | إيقاف تسرب بيانات اعتماد قاعدة البيانات إلى سياق الوكيل | |
+| `sanitize-private-key-content` | إعادة تحرير كتل مفاتيح PEM الخاصة من الإخراج | |
+| `sanitize-bearer-tokens` | إعادة تحرير رموز Authorization Bearer من الإخراج | |
+| `block-env-files` | منع الوكلاء من قراءة ملفات .env | |
+| `protect-env-vars` | منع الوكلاء من طباعة متغيرات البيئة | |
+| `block-read-outside-cwd` | احتفظ بالوكلاء داخل حدود المشروع | `allowPaths` |
+| `block-secrets-write` | منع الكتابة إلى ملفات المفاتيح الخاصة والشهادات | `additionalPatterns` |
+| `block-push-master` | منع الدفع العرضي إلى main/master | `protectedBranches` |
+| `block-work-on-main` | ابعد الوكلاء عن الفروع المحمية | `protectedBranches` |
+| `block-force-push` | منع `git push --force` | |
+| `warn-git-amend` | ذكر الوكلاء قبل تعديل الالتزامات | |
+| `warn-git-stash-drop` | ذكر الوكلاء قبل إسقاط المخزن المؤقت | |
+| `warn-all-files-staged` | اكتشف `git add -A` العرضي | |
+| `warn-destructive-sql` | اكتشف SQL DROP/DELETE قبل التنفيذ | |
+| `warn-schema-alteration` | اكتشف ALTER TABLE قبل التنفيذ | |
+| `warn-large-file-write` | اكتشف كتابات الملفات الكبيرة غير المتوقعة | `thresholdKb` |
+| `warn-package-publish` | اكتشف `npm publish` العرضي | |
+| `warn-background-process` | اكتشف عمليات الخلفية غير المقصودة | |
+| `warn-global-package-install` | اكتشف عمليات التثبيت العام غير المقصودة | |
+| …والمزيد | | |
+
+تفاصيل السياسة الكاملة ومرجع المعاملات: [docs/built-in-policies.mdx](docs/built-in-policies.mdx)
+
+---
+
+## السياسات المخصصة
+
+اكتب سياساتك الخاصة لجعل وكلاءك موثوقين وملتزمين بالمهام:
+
+```js
+import { customPolicies, allow, deny, instruct } from "failproofai";
+
+customPolicies.add({
+  name: "no-production-writes",
+  description: "Block writes to paths containing 'production'",
+  match: { events: ["PreToolUse"] },
+  fn: async (ctx) => {
+    if (!["Write", "Edit"].includes(ctx.toolName ?? "")) return allow();
+    const path = ctx.toolInput?.file_path ?? "";
+    if (path.includes("production")) return deny("Writes to production paths are blocked");
+    return allow();
+  },
+});
+```
+
+ثبتها باستخدام:
+
+```bash
+failproofai policies --install --custom ./my-policies.js
+```
+
+### مساعدات القرار
+
+| الدالة | التأثير |
+|----------|--------|
+| `allow()` | السماح بالعملية |
+| `allow(message)` | السماح وإرسال السياق المعلوماتي إلى Claude *(تجريبي)* |
+| `deny(message)` | حظر العملية؛ الرسالة معروضة ل Claude |
+| `instruct(message)` | إضافة سياق إلى موجه Claude؛ لا تحظر |
+
+### كائن السياق (`ctx`)
+
+| الحقل | النوع | الوصف |
+|-------|------|-------------|
+| `eventType` | `string` | `"PreToolUse"` أو `"PostToolUse"` أو `"Notification"` أو `"Stop"` |
+| `toolName` | `string` | الأداة التي يتم استدعاؤها (`"Bash"` أو `"Write"` أو `"Read"` وغيرها) |
+| `toolInput` | `object` | معاملات إدخال الأداة |
+| `payload` | `object` | حمولة الحدث الخام الكاملة |
+| `session.cwd` | `string` | دليل العمل لجلسة Claude Code |
+| `session.sessionId` | `string` | معرف الجلسة |
+| `session.transcriptPath` | `string` | المسار إلى ملف نص جلسة العمل |
+
+تدعم الخطافات المخصصة الاستيراد المحلي العابر، والانتظار غير المتزامن، والوصول إلى `process.env`. الأخطاء مفتوحة للفشل (تسجيل في `~/.failproofai/hook.log`، استمرار السياسات المدمجة). انظر [docs/custom-hooks.mdx](docs/custom-hooks.mdx) للحصول على الدليل الكامل.
+
+### السياسات المستندة إلى الاتفاقية (v0.0.2-beta.7+)
+
+ضع ملفات `*policies.{js,mjs,ts}` في `.failproofai/policies/` وسيتم تحميلها تلقائياً - لا حاجة لعلم `--custom` أو تغييرات التكوين. يعمل مثل git hooks: ضع الملف، وسيعمل.
+
+```text
+# مستوى المشروع — يتم الالتزام به في git، مشاركة مع الفريق
+.failproofai/policies/security-policies.mjs
+.failproofai/policies/workflow-policies.mjs
+
+# مستوى المستخدم — شخصي، ينطبق على جميع المشاريع
+~/.failproofai/policies/my-policies.mjs
+```
+
+يتم تحميل كلا المستويين (الاتحاد). يتم تحميل الملفات بترتيب أبجدي ضمن كل دليل. أضف بادئة `01-` أو `02-` وما إلى ذلك للتحكم في الترتيب. انظر [examples/convention-policies/](examples/convention-policies/) للحصول على أمثلة جاهزة للاستخدام.
+
+---
+
+## قياس الاستخدام
+
+يجمع Failproof AI بيانات قياس الاستخدام المجهول عبر PostHog لفهم استخدام الميزات. لا يتم أبداً إرسال محتوى الجلسة أو أسماء الملفات أو مدخلات الأدوات أو المعلومات الشخصية.
+
+عطله:
+
+```bash
+FAILPROOFAI_TELEMETRY_DISABLED=1 failproofai
+```
+
+---
+
+## التوثيق
+
+| الدليل | الوصف |
+|-------|-------------|
+| [البدء](docs/getting-started.mdx) | التثبيت والخطوات الأولى |
+| [السياسات المدمجة](docs/built-in-policies.mdx) | جميع السياسات المدمجة الـ 30 مع المعاملات |
+| [السياسات المخصصة](docs/custom-policies.mdx) | اكتب سياساتك الخاصة |
+| [التكوين](docs/configuration.mdx) | تنسيق ملف التكوين ودمج النطاق |
+| [لوحة التحكم](docs/dashboard.mdx) | مراقبة الجلسات ومراجعة نشاط السياسة |
+| [الهندسة المعمارية](docs/architecture.mdx) | كيفية عمل نظام الخطاف |
+| [الاختبار](docs/testing.mdx) | تشغيل الاختبارات وكتابة اختبارات جديدة |
+
+### تشغيل التوثيق محلياً
+
+```bash
+docker build -f Dockerfile.docs -t failproofai-docs .
+docker run --rm -p 3000:3000 failproofai-docs
+```
+
+يفتح موقع Mintlify docs في `http://localhost:3000`. الحاوية تراقب التغييرات إذا قمت بتركيب دليل التوثيق:
+
+```bash
+docker run --rm -p 3000:3000 -v $(pwd)/docs:/app/docs failproofai-docs
+```
+
+---
+
+## ملاحظة لمساهمي failproofai
+
+يستخدم `.claude/settings.json` الخاص بهذا المستودع `bun ./bin/failproofai.mjs --hook <EventType>` بدلاً من أمر `npx -y failproofai` القياسي. وذلك لأن تشغيل `npx -y failproofai` داخل مشروع failproofai نفسه يخلق تضاربة التعريف الذاتي.
+
+بالنسبة لجميع المستودعات الأخرى، يُنصح باستخدام `npx -y failproofai`، والذي تم تثبيته عبر:
+
+```bash
+failproofai policies --install --scope project
+```
+
+## المساهمة
+
+انظر [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## الترخيص
+
+انظر [LICENSE](LICENSE).
+
+---
+
+تم البناء والصيانة من قبل **ExosphereHost: مختبر البحث عن الموثوقية لوكلائك**. نساعد المؤسسات والشركات الناشئة على تحسين موثوقية وكلائهم الذكيين من خلال وكلائنا وبرامجنا وخبرتنا. تعرف على المزيد في [exosphere.host](https://exosphere.host).
+
+
+</div>