> ## Documentation Index
> Fetch the complete documentation index at: https://docs.befailproof.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Быстрый старт

> Установите failproofai, включите политики и дайте своим агентам работать надёжно

## Требования

* **Node.js** >= 20.9.0
* **Bun** >= 1.3.0 (опционально - требуется только для сборки из исходного кода)

***

## Установка

<CodeGroup>
  ```bash npm theme={null}
  npm install -g failproofai
  ```

  ```bash bun theme={null}
  bun add -g failproofai
  ```
</CodeGroup>

***

## Быстрый старт

<Steps>
  <Step title="Включите политики">
    Политики — это правила, которые выполняются перед и после каждого вызова инструмента агентом. Они перехватывают деструктивные команды, утечки секретов и другие сбои до того, как они нанесут ущерб.

    ```bash theme={null}
    failproofai policies --install
    ```

    Эта команда записывает записи хуков в установленные CLI агентов (Claude Code's `~/.claude/settings.json`, OpenAI Codex's `~/.codex/hooks.json`, GitHub Copilot CLI's `~/.copilot/hooks/failproofai.json`, Cursor Agent's `~/.cursor/hooks.json`, OpenCode's generated plugin shim at `~/.config/opencode/plugins/failproofai.mjs` plus a registration entry in `~/.config/opencode/opencode.json`'s `plugin` array, Pi's `~/.pi/agent/settings.json`, или Hermes's `~/.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` и также является источником автономного аудита.

    ```bash theme={null}
    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
    ```
  </Step>

  <Step title="Проверка">
    ```bash theme={null}
    failproofai policies
    ```

    Показывает все политики, включены ли они и все настроенные параметры.
  </Step>

  <Step title="Запустите панель управления">
    ```bash theme={null}
    failproofai
    ```

    Открывает локальную панель управления на `http://localhost:8020`, где вы можете просматривать сессии, инспектировать вызовы инструментов и управлять политиками.
  </Step>

  <Step title="Запустите своего агента">
    Запустите Claude Code как обычно. Если агент попытается что-то рискованное, failproofai автоматически это перехватит. Оставьте его работать без присмотра и просмотрите результаты на панели управления.
  </Step>
</Steps>

***

## Как работают политики

Каждый раз, когда агент запускает инструмент, Claude Code вызывает failproofai как подпроцесс:

```text theme={null}
Claude Code  →  failproofai --hook PreToolUse  →  читает JSON из stdin
                                                 оценивает политики
                                                 записывает решение в stdout
```

Каждая политика возвращает одно из трёх решений:

* **allow** — агент работает нормально
* **deny** — действие блокируется, агенту сообщается причина
* **instruct** — в запрос агента добавляется дополнительный контекст

<Note>
  Политики выполняются в вашем локальном процессе. Ничего не отправляется на удалённый сервис.
</Note>

***

## Установите командные политики с использованием соглашения о политиках

Самый быстрый способ установить стандарты качества в вашей команде — это соглашение `.failproofai/policies/`. Просто добавьте файлы политик в эту директорию, и они будут загружены автоматически — без флагов, без изменения конфигурации, без команд установки.

<Steps>
  <Step title="Создайте директорию политик">
    ```bash theme={null}
    mkdir -p .failproofai/policies
    ```
  </Step>

  <Step title="Добавьте файлы политик">
    Скопируйте примеры-шаблоны или напишите свои собственные:

    ```bash theme={null}
    cp node_modules/failproofai/examples/convention-policies/*.mjs .failproofai/policies/
    ```

    Или создайте новый:

    ```js theme={null}
    // .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("Run tests before committing.");
        }
        return allow();
      },
    });
    ```
  </Step>

  <Step title="Зафиксируйте в git">
    ```bash theme={null}
    git add .failproofai/policies/
    git commit -m "Add team quality policies"
    ```

    Каждый член команды, у которого установлен failproofai, автоматически получит эти политики. Не требуется настройка для каждого разработчика.
  </Step>
</Steps>

<Tip>
  Зафиксируйте `.failproofai/policies/` в вашем репозитории, чтобы вся команда следовала одним и тем же стандартам. По мере того, как ваша команда обнаруживает новые способы сбоев, добавляйте политики и публикуйте их — все получат обновление при следующем `git pull`. Со временем эти политики становятся живым стандартом качества, который постоянно улучшается.
</Tip>

***

## Хранение данных

Вся конфигурация и логи остаются на вашем компьютере:

| Путь                                      | Что здесь хранится                                         |
| ----------------------------------------- | ---------------------------------------------------------- |
| `~/.failproofai/policies-config.json`     | Глобальная конфигурация политик                            |
| `~/.failproofai/hook-activity.jsonl`      | История выполнения хуков                                   |
| `~/.failproofai/hook.log`                 | Лог отладки для ошибок пользовательских хуков              |
| `.failproofai/policies-config.json`       | Конфигурация для конкретного проекта (зафиксирована в git) |
| `.failproofai/policies-config.local.json` | Личные переопределения (в .gitignore)                      |

***

## Удаление

```bash theme={null}
failproofai policies --uninstall
```

Удаляет записи хуков из `~/.claude/settings.json`. Файлы конфигурации в `~/.failproofai/` сохраняются.

***

## Следующие шаги

<CardGroup cols={2}>
  <Card title="Конфигурация" icon="gear" href="/ru/configuration">
    Области действия и формат файла конфигурации
  </Card>

  <Card title="Встроенные политики" icon="shield" href="/ru/built-in-policies">
    Все 26 политик с параметрами
  </Card>

  <Card title="Пользовательские политики" icon="code" href="/ru/custom-policies">
    Напишите свои политики на JavaScript
  </Card>

  <Card title="Монитор агента" icon="chart-line" href="/ru/dashboard">
    Мониторьте сессии и проверяйте активность политик
  </Card>
</CardGroup>