failproofai 0.0.2-beta.2 → 0.0.2-beta.4

package/.next/standalone/docs/cli-reference.md

@@ -1,175 +0,0 @@
----
-title: CLI Reference
-description: "All commands, flags, and environment variables for the failproofai CLI"
-icon: terminal
----
-
-All commands are invoked via the `failproofai` binary.
-
----
-
-## Launch the dashboard
-
-```bash
-failproofai
-failproofai --start
-```
-
-Starts the web dashboard at `http://localhost:8020`. Use `--start` for production mode (Next.js standalone). The default bare invocation uses development mode with auto-reload.
-
-**Options (dev mode only):**
-
-| Flag | Description |
-|------|-------------|
-| `--port <number>` | Port to listen on (default: `8020`) |
-| `--projects-path <path>` | Override the Claude projects path |
-| `--allowed-origins <origins>` | Comma-separated list of hosts/IPs allowed to access dev resources (e.g. HMR websocket). Required when accessing the dev server from a hostname other than `localhost`. |
-
-**Example — allow a custom hostname in dev:**
-
-```bash
-npm run dev -- --allowed-origins dashboard.example.com
-# or multiple:
-npm run dev -- --allowed-origins dashboard.example.com,192.168.1.5
-```
-
-You can also set the env var directly instead of using the flag:
-
-```bash
-FAILPROOFAI_ALLOWED_DEV_ORIGINS=dashboard.example.com npm run dev
-```
-
----
-
-## Hook handler (internal)
-
-```bash
-failproofai --hook <EventType>
-```
-
-This is the command written into Claude Code's `settings.json` by `--install-policies`. You will not normally call this directly.
-
-**EventType** is one of: `PreToolUse`, `PostToolUse`, `Notification`, `Stop`.
-
-Reads a JSON payload from stdin, evaluates all enabled policies, writes a decision to stdout, and exits.
-
----
-
-## Install policies
-
-```bash
-failproofai --install-policies [policy-names...] [options]
-```
-
-Writes hook entries into Claude Code's `settings.json` so that failproofai intercepts tool calls.
-
-**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>` | Path to a JS file containing custom hook policies |
-| `--beta` | Include beta policies in installation |
-
-**Examples:**
-
-```bash
-# Install all default policies globally
-failproofai --install-policies
-
-# Install two specific policies for the current project
-failproofai --install-policies block-sudo sanitize-api-keys --scope project
-
-# Install with a custom hooks file
-failproofai --install-policies --custom ./my-policies.js
-```
-
-When `--custom <path>` is provided, the resolved absolute path is saved to `policies-config.json` as `customPoliciesPath`. The file is loaded and executed at hook-fire time (not at install time).
-
----
-
-## Remove policies
-
-```bash
-failproofai --remove-policies [policy-names...] [options]
-```
-
-Removes failproofai hook entries from Claude Code's `settings.json`.
-
-**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 |
-| `--custom` | Clear the `customPoliciesPath` from config |
-
-**Examples:**
-
-```bash
-# Remove all policies globally
-failproofai --remove-policies
-
-# Remove a specific policy
-failproofai --remove-policies block-sudo
-
-# Remove custom hooks path
-failproofai --remove-policies --custom
-```
-
----
-
-## List policies
-
-```bash
-failproofai --list-policies
-```
-
-Prints all available policies with their status, configured parameters, and custom hooks.
-
-**Sample output:**
-
-```
-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 Hooks (/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 (not at hook-fire time, so you can catch typos).
-
----
-
-## Print version
-
-```bash
-failproofai --version
-```
-
-Prints the installed version number.
-
----
-
-## Environment variables
-
-| Variable | Description |
-|----------|-------------|
-| `FAILPROOFAI_TELEMETRY_DISABLED=1` | Disable anonymous usage telemetry |
-| `FAILPROOFAI_LOG_LEVEL=info\|warn\|error` | Server log level (default: `warn`) |
-| `FAILPROOFAI_DISABLE_PAGES=policies,projects` | Comma-separated list of dashboard pages to disable |
-| `FAILPROOFAI_ALLOWED_DEV_ORIGINS` | Comma-separated list of hosts/IPs allowed to access Next.js dev resources (HMR). Dev mode only. Equivalent to `--allowed-origins`. |
-| `CLAUDE_PROJECTS_PATH` | Override the path where Claude Code project folders are found |

package/.next/standalone/docs/getting-started.md

@@ -1,128 +0,0 @@
----
-title: Getting Started
-description: "Install failproofai, enable policies, and take it for a spin"
-icon: rocket
----
-
-## Requirements
-
-- **Node.js** >= 20.9.0
-- **Bun** >= 1.3.0 (optional — only needed for development / building from source)
-
----
-
-## Installation
-
-```bash
-npm install -g failproofai
-# or
-bun add -g failproofai
-```
-
----
-
-## Quick Start
-
-### 1. Launch the dashboard
-
-```bash
-failproofai
-```
-
-Opens a local web dashboard at `http://localhost:8020`. The dashboard lets you browse your Claude Code projects and sessions, inspect session logs and tool calls, and manage policies.
-
-### 2. Install policies
-
-Policies are the security rules that Claude Code enforces when it runs tools. Installing them writes hook entries into Claude Code's `settings.json`.
-
-**Install globally** (applies to all Claude Code sessions):
-
-```bash
-failproofai --install-policies
-```
-
-**Install for the current project only:**
-
-```bash
-failproofai --install-policies --scope project
-```
-
-**Install specific policies by name:**
-
-```bash
-failproofai --install-policies block-sudo block-rm-rf sanitize-api-keys
-```
-
-See [Built-in Policies](./built-in-policies.md) for the full list.
-
-### 3. Verify installation
-
-```bash
-failproofai --list-policies
-```
-
-This shows every policy, whether it is enabled, and any configured parameters.
-
-### 4. Try it out
-
-Once policies are installed, run Claude Code as normal. When Claude attempts a blocked action (e.g. `sudo`, `rm -rf`, or outputting an API key), failproofai intercepts and blocks it automatically.
-
----
-
-## How policies work
-
-When Claude Code is about to run a tool (a `PreToolUse` event), or has just run one (a `PostToolUse` event), it invokes failproofai as a subprocess:
-
-```
-Claude Code  →  failproofai --hook PreToolUse  →  stdin: JSON payload
-                                                  stdout: decision JSON
-                                                  exit code: 0 (allow/instruct) or 2 (deny on Stop)
-```
-
-failproofai reads the tool name and input, evaluates all enabled policies, and returns a decision:
-
-- **allow** — Claude proceeds normally (empty stdout)
-- **deny** — Claude is told the action is blocked and why
-- **instruct** — Claude gets extra context/instructions added to its prompt
-
-Policies run entirely in your local process. Nothing is sent to a remote service.
-
----
-
-## Data storage
-
-failproofai stores all configuration and logs locally:
-
-| Path | Contents |
-|------|----------|
-| `~/.failproofai/policies-config.json` | Global policy configuration |
-| `~/.failproofai/hook-activity.jsonl` | Hook execution history (one JSON line per event) |
-| `~/.failproofai/hook.log` | Debug log for custom hook errors |
-| `.failproofai/policies-config.json` | Per-project policy configuration (committed) |
-| `.failproofai/policies-config.local.json` | Per-project personal overrides (gitignored) |
-
----
-
-## Uninstalling
-
-```bash
-failproofai --remove-policies
-```
-
-Removes the hook entries from `~/.claude/settings.json`. The failproofai configuration files in `~/.failproofai/` are left in place.
-
-To remove for a specific scope:
-
-```bash
-failproofai --remove-policies --scope project
-```
-
----
-
-## Next steps
-
-- [Configuration](./configuration.md) — understand scopes and the config file format
-- [Built-in Policies](./built-in-policies.md) — full list of policies and their parameters
-- [Custom Hooks](./custom-hooks.md) — write your own policies in JavaScript
-- [Dashboard](./dashboard.md) — using the session viewer and policy manager
-- [CLI Reference](./cli-reference.md) — all flags and commands

package/.next/standalone/docs/introduction.md

@@ -1,47 +0,0 @@
----
-title: Introduction
-description: "Open-source hooks, policies, and session visualization for Claude Code and the Agents SDK"
----
-
-# Failproof AI
-
-Open-source hooks, policies, and session visualization for **Claude Code** and the **Agents SDK**. Runs entirely locally — no data leaves your machine.
-
-## What is Failproof AI?
-
-Failproof AI is a security and observability toolkit that intercepts Claude Code tool calls in real time. It evaluates configurable policies — blocking dangerous commands, redacting secrets, and adding safety instructions — before Claude can act.
-
-It also includes a local web dashboard for browsing Claude Code sessions, inspecting tool calls, and managing policies visually.
-
-## Key features
-
-| Feature | Description |
-|---------|-------------|
-| [35+ Built-in Policies](./built-in-policies.md) | Block sudo, rm -rf, force-push, secret leaks, and more — out of the box. |
-| [Custom Hooks](./custom-hooks.md) | Write your own policies in JavaScript with a simple allow/deny/instruct API. |
-| [Session Dashboard](./dashboard.md) | Browse projects, inspect sessions, and review every tool call and policy decision. |
-| [Three-Scope Config](./configuration.md) | Global, project, and local configuration with automatic merging. |
-
-## Quick start
-
-Install globally:
-
-```bash
-npm install -g failproofai
-# or
-bun add -g failproofai
-```
-
-Enable policies:
-
-```bash
-failproofai --install-policies
-```
-
-Launch the dashboard:
-
-```bash
-failproofai
-```
-
-See the [Getting Started](./getting-started.md) guide for a full walkthrough.