Skip to main content

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 policies --install [policy-names...] [options]
Writes hook entries into your installed agent CLI’s settings file (Claude Code, OpenAI Codex, or GitHub Copilot CLI (beta)) so failproofai intercepts tool calls. Aliases: failproofai p -i

​
Options

FlagDescription
--cli claude|codex|copilotAgent CLI(s) to install for; space-separated (e.g. --cli claude codex copilot) or repeated. Omit to detect installed CLIs and prompt.
--scope userInstall into the user-scope settings file (Claude: ~/.claude/settings.json; Codex: ~/.codex/hooks.json; Copilot: ~/.copilot/hooks/failproofai.json). Default.
--scope projectInstall into the project-scope settings file (Claude: <cwd>/.claude/settings.json; Codex: <cwd>/.codex/hooks.json; Copilot: <cwd>/.github/hooks/failproofai.json).
--scope localClaude only — installs into <cwd>/.claude/settings.local.json. Codex and Copilot do not have a local scope.
--custom <path> / -cPath 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

# 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

# Install for OpenAI Codex (project scope)
failproofai policies --install --cli codex --scope project

# Install for GitHub Copilot CLI (beta) for the current project
failproofai policies --install --cli copilot --scope project

# Install for all three CLIs at once
failproofai policies --install --cli claude codex copilot
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.