failproofai 0.0.6-beta.2 → 0.0.6-beta.4

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

@@ -1,47 +0,0 @@
----
-title: Install policies
-description: "Enable policies so they run on every agent tool call"
----
-
-```bash
-failproofai policies --install [policy-names...] [options]
-```
-
-Writes hook entries into Claude Code's `settings.json` so failproofai intercepts tool calls.
-
-Aliases: `failproofai p -i`
-
-## Options
-
-| Flag | Description |
-|------|-------------|
-| `--scope user` | Install into `~/.claude/settings.json` (default - all sessions) |
-| `--scope project` | Install into `.claude/settings.json` in the current directory |
-| `--scope local` | Install into `.claude/settings.local.json` in the current directory |
-| `--custom <path>` / `-c` | Path to a JS file containing custom hook policies |
-
-## Behavior
-
-- **No policy names** - opens an interactive prompt to select policies
-- **Specific names** - enables those policies (added to any already enabled)
-- **`all`** - enables every available policy
-
-Installation is additive: running `--install` again adds new policies without removing existing ones.
-
-## Examples
-
-```bash
-# Install all default policies globally (interactive)
-failproofai policies --install
-
-# Install specific policies for the current project
-failproofai policies --install block-sudo sanitize-api-keys --scope project
-
-# Enable all policies at once
-failproofai policies --install all
-
-# Install with a custom policies file
-failproofai policies --install --custom ./my-policies.js
-```
-
-When `--custom <path>` is provided, the file is validated immediately - it must call `customPolicies.add()` at least once. The resolved path is saved to `policies-config.json` as `customPoliciesPath`.

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

@@ -1,31 +0,0 @@
----
-title: List policies
-description: "See which policies are enabled, their parameters, and custom policies"
----
-
-```bash
-failproofai policies
-```
-
-Shows all policies with their status, configured parameters, and custom policies.
-
-## Sample output
-
-```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
-```
-
-Unknown keys in `policyParams` are flagged here so you can catch typos early.

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

@@ -1,43 +0,0 @@
----
-title: Uninstall policies
-description: "Remove hook entries from Claude Code's settings"
----
-
-```bash
-failproofai policies --uninstall [policy-names...] [options]
-```
-
-Removes failproofai hook entries from Claude Code's `settings.json`.
-
-Aliases: `failproofai p -u`
-
-## Options
-
-| Flag | Description |
-|------|-------------|
-| `--scope user` | Remove from global settings (default) |
-| `--scope project` | Remove from project settings |
-| `--scope local` | Remove from local settings |
-| `--scope all` | Remove from all scopes at once |
-| `--custom` / `-c` | Clear the `customPoliciesPath` from config |
-
-## Behavior
-
-- **No policy names** - removes all failproofai hook entries from the settings file
-- **Specific names** - disables those policies but keeps hooks installed
-
-## Examples
-
-```bash
-# Remove all hooks globally
-failproofai policies --uninstall
-
-# Disable a specific policy (keeps hooks installed)
-failproofai policies --uninstall block-sudo
-
-# Remove hooks from every scope
-failproofai policies --uninstall --scope all
-
-# Clear custom policies path
-failproofai policies --uninstall --custom
-```

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

@@ -1,12 +0,0 @@
----
-title: Check version
-description: "Print the installed failproofai version"
----
-
-```bash
-failproofai --version
-# or
-failproofai -v
-```
-
-Prints the installed version number.

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

@@ -1,222 +0,0 @@
----
-title: Configuration
-description: "Config file format, three-scope system, and merge rules"
-icon: gear
----
-
-failproofai uses JSON configuration files to control which policies are active, how they behave, and where custom policies are loaded from. Configuration is designed to be easy to share with your team - commit it to your repo and every developer gets the same agent safety net.
-
----
-
-## Configuration scopes
-
-There are three configuration scopes, evaluated in priority order:
-
-| Scope | File path | Purpose |
-|-------|-----------|---------|
-| **project** | `.failproofai/policies-config.json` | Per-repo settings, committed to version control |
-| **local** | `.failproofai/policies-config.local.json` | Personal per-repo overrides, gitignored |
-| **global** | `~/.failproofai/policies-config.json` | User-level defaults across all projects |
-
-When failproofai receives a hook event, it loads and merges all three files that exist for the current working directory.
-
-### Merge rules
-
-**`enabledPolicies`** - the union of all three scopes. A policy enabled at any level is active.
-
-```text
-project:  ["block-sudo"]
-local:    ["block-rm-rf"]
-global:   ["block-sudo", "sanitize-api-keys"]
-
-resolved: ["block-sudo", "block-rm-rf", "sanitize-api-keys"]  ← deduplicated union
-```
-
-**`policyParams`** - first scope that defines params for a given policy wins entirely. There is no deep merging of values within a policy's params.
-
-```text
-project:  block-sudo → { allowPatterns: ["sudo apt-get update"] }
-global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
-
-resolved: { allowPatterns: ["sudo apt-get update"] }   ← project wins, global ignored
-```
-
-```text
-project:  (no block-sudo entry)
-local:    (no block-sudo entry)
-global:   block-sudo → { allowPatterns: ["sudo systemctl status"] }
-
-resolved: { allowPatterns: ["sudo systemctl status"] }  ← falls through to global
-```
-
-**`customPoliciesPath`** - first scope that defines it wins.
-
-**`llm`** - first scope that defines it wins.
-
----
-
-## Config file format
-
-```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"
-}
-```
-
----
-
-## Field reference
-
-### `enabledPolicies`
-
-Type: `string[]`
-
-List of policy names to enable. Names must match exactly the policy identifiers shown by `failproofai policies`. See [Built-in Policies](/built-in-policies) for the full list.
-
-Policies not in `enabledPolicies` are inactive, even if they have entries in `policyParams`.
-
-### `policyParams`
-
-Type: `Record<string, Record<string, unknown>>`
-
-Per-policy parameter overrides. The outer key is the policy name; the inner keys are policy-specific. Each policy documents its available parameters in [Built-in Policies](/built-in-policies).
-
-If a policy has parameters but you don't specify them, the policy's built-in defaults are used. Users who do not configure `policyParams` at all get identical behavior to previous versions.
-
-Unknown keys inside a policy's params block are silently ignored at hook-fire time but flagged as warnings when you run `failproofai policies`.
-
-#### `hint` (cross-cutting)
-
-Type: `string` (optional)
-
-A message appended to the reason when a policy returns `deny` or `instruct`. Use it to give Claude actionable guidance without modifying the policy itself.
-
-Works with any policy type — built-in, custom (`custom/`), project convention (`.failproofai-project/`), or user convention (`.failproofai-user/`).
-
-```json
-{
-  "policyParams": {
-    "block-force-push": {
-      "hint": "Try creating a fresh branch instead."
-    },
-    "block-sudo": {
-      "allowPatterns": ["sudo apt-get"],
-      "hint": "Use apt-get directly without sudo."
-    },
-    "custom/my-policy": {
-      "hint": "Ask the user for approval first."
-    }
-  }
-}
-```
-
-When `block-force-push` denies, Claude sees: *"Force-pushing is blocked. Try creating a fresh branch instead."*
-
-Non-string values and empty strings are silently ignored. If `hint` is not set, behavior is unchanged (backward-compatible).
-
-### `customPoliciesPath`
-
-Type: `string` (absolute path)
-
-Path to a JavaScript file containing custom hook policies. This is set automatically by `failproofai policies --install --custom <path>` (the path is resolved to absolute before being stored).
-
-The file is loaded fresh on every hook event - there is no caching. See [Custom Policies](/custom-policies) for authoring details.
-
-### Convention-based policies
-
-In addition to the explicit `customPoliciesPath`, failproofai automatically discovers and loads policy files from `.failproofai/policies/` directories:
-
-| Level | Directory | Scope |
-|-------|-----------|-------|
-| Project | `.failproofai/policies/` | Shared with team via version control |
-| User | `~/.failproofai/policies/` | Personal, applies to all projects |
-
-**File matching:** Only files matching `*policies.{js,mjs,ts}` are loaded (e.g. `security-policies.mjs`, `workflow-policies.js`). Other files in the directory are ignored.
-
-**No config needed:** Convention policies require no entries in `policies-config.json`. Just drop files into the directory and they're picked up on the next hook event.
-
-**Union loading:** Both project and user convention directories are scanned. All matching files from both levels are loaded (unlike `customPoliciesPath` which uses first-scope-wins).
-
-See [Custom Policies](/custom-policies) for more details and examples.
-
-### `llm`
-
-Type: `object` (optional)
-
-LLM client configuration for policies that make AI calls. Not required for most setups.
-
-```json
-{
-  "llm": {
-    "model": "claude-sonnet-4-6",
-    "apiKey": "sk-ant-..."
-  }
-}
-```
-
----
-
-## Managing configuration from the CLI
-
-The `policies --install` and `policies --uninstall` commands write to Claude Code's `settings.json` (the hook entry points), while `policies-config.json` is the file you manage directly. The two are separate:
-
-- **`settings.json`** - tells Claude Code to call `failproofai --hook <event>` on each tool use
-- **`policies-config.json`** - tells failproofai which policies to evaluate and with what params
-
-You can edit `policies-config.json` directly at any time; changes take effect immediately on the next hook event with no restart needed.
-
----
-
-## Example: project-level config with team defaults
-
-Commit `.failproofai/policies-config.json` to your repo:
-
-```json
-{
-  "enabledPolicies": [
-    "block-sudo",
-    "block-rm-rf",
-    "block-push-master",
-    "sanitize-api-keys",
-    "block-env-files"
-  ],
-  "policyParams": {
-    "block-push-master": {
-      "protectedBranches": ["main", "release", "hotfix"]
-    }
-  }
-}
-```
-
-Each developer can then create `.failproofai/policies-config.local.json` (gitignored) for personal overrides without affecting teammates.