@flowrail/init
v0.1.8
Published
One-shot FlowRail installer for Claude Code (default) and OpenAI Codex (--agent codex). Wires hooks, MCP server config, and skills into your repo, then probes the FlowRail server with your API key.
Readme
@flowrail/init
One-shot installer that wires FlowRail — security review for AI coding agents — into a Claude Code project: PreToolUse hooks, MCP server config, and agent-facing skills.
# 1. Sign up and mint an API key at https://flowrail.ai/settings/keys
export FLOWRAIL_API_KEY=<your key>
# 2. Run the installer from the repo you want FlowRail to protect
cd ~/code/your-repo
npx @flowrail/init@latestWhat it writes:
.claude/settings.json— PreToolUse hooks for Write/Edit/MultiEdit + Bash. Tracked. No credentials..mcp.json— Claude Code MCP wiring. Tracked. Carries aBearer ${FLOWRAIL_API_KEY}env-reference, never the literal key..claude/skills/flowrail-*/SKILL.md— the agent-facing skills (design-review, verify, dep-check, review-app, lineage).flowrail.yaml— project config placeholder for scanner orchestration and org defaults..gitignore— appends.flowrail/so per-session runtime state (the active design review id) stays local.
The installer finishes by probing https://api.flowrail.ai/mcp with your key to confirm end-to-end auth before exiting. A 401 gets an actionable message; transport failures get a different one.
OpenAI Codex (experimental)
npx @flowrail/init@latest --agent codexThis installs and self-tests the exact @flowrail/hook release it pins, then writes:
.codex/hooks.json: four exact-pinned hooks..codex/config.toml: the MCP server; the bearer comes fromFLOWRAIL_API_KEY..agents/skills/and a FlowRail section inAGENTS.md.scripts/check-flowrail-codex.mjs: the readiness check.
Nothing under .claude/ changes.
Codex runs the hooks only after you trust the project and approve the hooks in /hooks.
Run node scripts/check-flowrail-codex.mjs until it reports readiness: active. Details:
https://flowrail.ai/docs.
Links
- Website: https://flowrail.ai
- Docs: https://flowrail.ai/docs
- Mint or manage API keys: https://flowrail.ai/settings/keys
