failproofai 0.0.2 → 0.0.3

package/.next/standalone/docs/ru/cli/install-policies.mdx

@@ -0,0 +1,48 @@
+---
+title: Установка политик
+description: "Включите политики, чтобы они запускались при каждом вызове инструмента агента"
+---
+
+```bash
+failproofai policies --install [policy-names...] [options]
+```
+
+Записывает записи hook в `settings.json` Claude Code, чтобы failproofai перехватывал вызовы инструментов.
+
+Псевдонимы: `failproofai p -i`
+
+## Опции
+
+| Флаг | Описание |
+|------|-------------|
+| `--scope user` | Установить в `~/.claude/settings.json` (по умолчанию - все сеансы) |
+| `--scope project` | Установить в `.claude/settings.json` в текущей директории |
+| `--scope local` | Установить в `.claude/settings.local.json` в текущей директории |
+| `--custom <path>` / `-c` | Путь к файлу JS, содержащему пользовательские hook политики |
+| `--beta` | Включить бета-политики |
+
+## Поведение
+
+- **Без названий политик** - открывает интерактивное приглашение для выбора политик
+- **Конкретные названия** - включает эти политики (добавляются к уже включённым)
+- **`all`** - включает все доступные политики
+
+Установка является аддитивной: повторный запуск `--install` добавляет новые политики без удаления существующих.
+
+## Примеры
+
+```bash
+# Установить все политики по умолчанию глобально (интерактивно)
+failproofai policies --install
+
+# Установить конкретные политики для текущего проекта
+failproofai policies --install block-sudo sanitize-api-keys --scope project
+
+# Включить все политики одновременно
+failproofai policies --install all
+
+# Установить с пользовательским файлом политик
+failproofai policies --install --custom ./my-policies.js
+```
+
+Когда указано `--custom <path>`, файл проверяется немедленно - он должен вызвать `customPolicies.add()` хотя бы один раз. Разрешённый путь сохраняется в `policies-config.json` как `customPoliciesPath`.

package/.next/standalone/docs/ru/cli/list-policies.mdx

@@ -0,0 +1,32 @@
+---
+---
+title: Список политик
+description: "Посмотрите, какие политики включены, их параметры и пользовательские политики"
+---
+
+```bash
+failproofai policies
+```
+
+Показывает все политики с их статусом, настроенными параметрами и пользовательскими политиками.
+
+## Пример вывода
+
+```text
+Failproof AI Hook Policies (user)
+
+  Status  Name                          Description
+  ──────  ──────────────────────────────────────────────────────────────
+  ✓       block-sudo                    Block sudo commands
+            allowPatterns: ["sudo systemctl status"]
+  ✓       block-rm-rf                   Block recursive deletions
+  ✗       block-curl-pipe-sh            Block curl|bash patterns
+  ✓       sanitize-api-keys             Redact API keys from output
+            additionalPatterns: [{ regex: "MY_TOKEN_...", label: "..." }]
+
+  ── Custom Policies (/home/alice/myproject/my-policies.js) ──────────────
+  ✓       require-jira-ticket           Block commits without ticket
+  ✓       approval-gate                 Approval gate for destructive ops
+```
+
+Неизвестные ключи в `policyParams` здесь помечаются, чтобы вы могли рано поймать опечатки.

package/.next/standalone/docs/ru/cli/remove-policies.mdx

@@ -0,0 +1,44 @@
+---
+title: Удаление политик
+description: "Удаление записей hook из настроек Claude Code"
+---
+
+```bash
+failproofai policies --uninstall [policy-names...] [options]
+```
+
+Удаляет записи failproofai hook из `settings.json` Claude Code.
+
+Синонимы: `failproofai p -u`
+
+## Параметры
+
+| Флаг | Описание |
+|------|----------|
+| `--scope user` | Удалить из глобальных настроек (по умолчанию) |
+| `--scope project` | Удалить из настроек проекта |
+| `--scope local` | Удалить из локальных настроек |
+| `--scope all` | Удалить из всех областей одновременно |
+| `--custom` / `-c` | Очистить `customPoliciesPath` из конфигурации |
+| `--beta` | Удалить только бета-политики из конфигурации |
+
+## Поведение
+
+- **Без названий политик** — удаляет все записи failproofai hook из файла настроек
+- **Конкретные названия** — отключает указанные политики, но оставляет hooks установленными
+
+## Примеры
+
+```bash
+# Удалить все hooks глобально
+failproofai policies --uninstall
+
+# Отключить конкретную политику (оставляет hooks установленными)
+failproofai policies --uninstall block-sudo
+
+# Удалить hooks из всех областей
+failproofai policies --uninstall --scope all
+
+# Очистить путь к пользовательским политикам
+failproofai policies --uninstall --custom
+```

package/.next/standalone/docs/ru/cli/version.mdx

@@ -0,0 +1,12 @@
+---
+title: Проверка версии
+description: "Вывести установленную версию failproofai"
+---
+
+```bash
+failproofai --version
+# or
+failproofai -v
+```
+
+Выводит номер установленной версии.

package/.next/standalone/docs/ru/configuration.mdx

@@ -0,0 +1,223 @@
+---
+---
+title: Конфигурация
+description: "Формат файла конфигурации, трёхуровневая система и правила слияния"
+icon: gear
+---
+
+failproofai использует JSON файлы конфигурации для управления активными политиками, их поведением и источниками пользовательских политик. Конфигурация разработана так, чтобы её было легко делиться с командой — закоммитьте её в репозиторий, и каждый разработчик получит одинаковую защиту агента.
+
+---
+
+## Уровни конфигурации
+
+Существует три уровня конфигурации, оцениваемые в порядке приоритета:
+
+| Уровень | Путь файла | Назначение |
+|---------|-----------|-----------|
+| **project** | `.failproofai/policies-config.json` | Настройки репозитория, коммитятся в систему контроля версий |
+| **local** | `.failproofai/policies-config.local.json` | Личные переопределения на уровне репозитория, в .gitignore |
+| **global** | `~/.failproofai/policies-config.json` | Пользовательские стандартные значения для всех проектов |
+
+Когда failproofai получает событие hook, он загружает и объединяет все три существующих файла для текущей директории.
+
+### Правила слияния
+
+**`enabledPolicies`** — объединение всех трёх уровней. Политика, активированная на любом уровне, работает.
+
+```text
+project:  ["block-sudo"]
+local:    ["block-rm-rf"]
+global:   ["block-sudo", "sanitize-api-keys"]
+
+resolved: ["block-sudo", "block-rm-rf", "sanitize-api-keys"]  ← объединение без дубликатов
+```
+
+**`policyParams`** — первый уровень, определивший параметры для данной политики, полностью выигрывает. Нет глубокого слияния значений в параметрах политики.
+
+```text
+project:  block-sudo → { allowPatterns: ["sudo apt-get update"] }
+global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
+
+resolved: { allowPatterns: ["sudo apt-get update"] }   ← выигрывает project, global игнорируется
+```
+
+```text
+project:  (нет записи block-sudo)
+local:    (нет записи block-sudo)
+global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
+
+resolved: { allowPatterns: ["sudo systemctl status"] }  ← переходит на global
+```
+
+**`customPoliciesPath`** — первый уровень, определивший его, выигрывает.
+
+**`llm`** — первый уровень, определивший его, выигрывает.
+
+---
+
+## Формат файла конфигурации
+
+```json
+{
+  "enabledPolicies": [
+    "block-sudo",
+    "block-rm-rf",
+    "block-push-master",
+    "sanitize-api-keys",
+    "sanitize-jwt",
+    "block-env-files",
+    "block-read-outside-cwd"
+  ],
+  "policyParams": {
+    "block-sudo": {
+      "allowPatterns": ["sudo systemctl status", "sudo journalctl"]
+    },
+    "block-push-master": {
+      "protectedBranches": ["main", "release", "prod"]
+    },
+    "block-rm-rf": {
+      "allowPaths": ["/tmp"]
+    },
+    "block-read-outside-cwd": {
+      "allowPaths": ["/shared/data", "/opt/company"]
+    },
+    "sanitize-api-keys": {
+      "additionalPatterns": [
+        { "regex": "myco_[A-Za-z0-9]{32}", "label": "MyCo API key" }
+      ]
+    },
+    "warn-large-file-write": {
+      "thresholdKb": 512
+    }
+  },
+  "customPoliciesPath": "/home/alice/myproject/my-policies.js"
+}
+```
+
+---
+
+## Справка по полям
+
+### `enabledPolicies`
+
+Тип: `string[]`
+
+Список имён политик для активации. Имена должны точно совпадать с идентификаторами политик, показываемыми командой `failproofai policies`. Полный список см. в разделе [Built-in Policies](/ru/built-in-policies).
+
+Политики, отсутствующие в `enabledPolicies`, неактивны, даже если у них есть записи в `policyParams`.
+
+### `policyParams`
+
+Тип: `Record<string, Record<string, unknown>>`
+
+Переопределения параметров для каждой политики. Внешний ключ — имя политики; внутренние ключи — специфичны для политики. Каждая политика документирует свои доступные параметры в разделе [Built-in Policies](/ru/built-in-policies).
+
+Если политика имеет параметры, но вы их не указали, используются встроенные значения по умолчанию политики. Пользователи, которые вообще не конфигурируют `policyParams`, получают идентичное поведение с предыдущими версиями.
+
+Неизвестные ключи в блоке параметров политики молча игнорируются при срабатывании hook, но отмечаются как предупреждения при выполнении `failproofai policies`.
+
+#### `hint` (кросс-функциональный)
+
+Тип: `string` (опционально)
+
+Сообщение, добавляемое к причине, когда политика возвращает `deny` или `instruct`. Используйте его, чтобы дать Claude практические рекомендации без изменения самой политики.
+
+Работает с любым типом политики — встроенной, пользовательской (`custom/`), проектной конвенции (`.failproofai-project/`) или пользовательской конвенции (`.failproofai-user/`).
+
+```json
+{
+  "policyParams": {
+    "block-force-push": {
+      "hint": "Попробуйте создать свежую ветку вместо этого."
+    },
+    "block-sudo": {
+      "allowPatterns": ["sudo apt-get"],
+      "hint": "Используйте apt-get напрямую без sudo."
+    },
+    "custom/my-policy": {
+      "hint": "Сначала запросите одобрение у пользователя."
+    }
+  }
+}
+```
+
+Когда `block-force-push` запрещает, Claude видит: *"Force-pushing заблокирован. Попробуйте создать свежую ветку вместо этого."*
+
+Значения, не являющиеся строками, и пустые строки молча игнорируются. Если `hint` не установлен, поведение не изменяется (обратная совместимость).
+
+### `customPoliciesPath`
+
+Тип: `string` (абсолютный путь)
+
+Путь к JavaScript файлу, содержащему пользовательские hook политики. Устанавливается автоматически командой `failproofai policies --install --custom <path>` (путь преобразуется в абсолютный перед сохранением).
+
+Файл загружается заново при каждом события hook — кеширования нет. Детали разработки см. в разделе [Custom Policies](/ru/custom-policies).
+
+### Политики на основе конвенций (v0.0.2-beta.7+)
+
+В дополнение к явному `customPoliciesPath`, failproofai автоматически обнаруживает и загружает файлы политик из директорий `.failproofai/policies/`:
+
+| Уровень | Директория | Уровень |
+|---------|-----------|--------|
+| Project | `.failproofai/policies/` | Общая с командой через систему контроля версий |
+| User | `~/.failproofai/policies/` | Личная, применяется ко всем проектам |
+
+**Соответствие файлов:** Загружаются только файлы, соответствующие маске `*policies.{js,mjs,ts}` (например, `security-policies.mjs`, `workflow-policies.js`). Другие файлы в директории игнорируются.
+
+**Конфигурация не требуется:** Политики на основе конвенций не требуют записей в `policies-config.json`. Просто поместите файлы в директорию, и они будут обнаружены при следующем событии hook.
+
+**Загрузка объединением:** Сканируются обе директории конвенций — проектная и пользовательская. Загружаются все соответствующие файлы с обоих уровней (в отличие от `customPoliciesPath`, который использует first-scope-wins).
+
+Детали и примеры см. в разделе [Custom Policies](/ru/custom-policies).
+
+### `llm`
+
+Тип: `object` (опционально)
+
+Конфигурация LLM клиента для политик, делающих AI вызовы. Не требуется для большинства установок.
+
+```json
+{
+  "llm": {
+    "model": "claude-sonnet-4-6",
+    "apiKey": "sk-ant-..."
+  }
+}
+```
+
+---
+
+## Управление конфигурацией через CLI
+
+Команды `policies --install` и `policies --uninstall` записывают в `settings.json` Claude Code (точки входа для hook), в то время как `policies-config.json` — это файл, который вы управляете напрямую. Это два отдельных файла:
+
+- **`settings.json`** — указывает Claude Code вызывать `failproofai --hook <event>` при каждом использовании инструмента
+- **`policies-config.json`** — указывает failproofai, какие политики оценивать и с какими параметрами
+
+Вы можете редактировать `policies-config.json` напрямую в любое время; изменения вступают в силу на следующем события hook без необходимости перезагрузки.
+
+---
+
+## Пример: конфигурация на уровне проекта с командными стандартами
+
+Закоммитьте `.failproofai/policies-config.json` в ваш репозиторий:
+
+```json
+{
+  "enabledPolicies": [
+    "block-sudo",
+    "block-rm-rf",
+    "block-push-master",
+    "sanitize-api-keys",
+    "block-env-files"
+  ],
+  "policyParams": {
+    "block-push-master": {
+      "protectedBranches": ["main", "release", "hotfix"]
+    }
+  }
+}
+```
+
+Каждый разработчик может затем создать `.failproofai/policies-config.local.json` (в .gitignore) для личных переопределений без влияния на коллег.