Enforce AI coding standards across every agent and tool
Rulebook generates AGENTS.md and an MCP server so every AI coding agent follows the same rules, quality gates, and spec-driven tasks.
7.1.0Add to Favorites
Why it matters
Rulebook ensures every AI coding agent-Claude Code, Cursor, Copilot, Gemini-follows the same quality rules, structural gates, and spec-driven workflows from a single source of truth (AGENTS.md), eliminating inconsistent, error-prone AI-generated code across your entire development workflow.
Outcomes
What it gets done
Generate universal AGENTS.md rules that every AI coding tool reads natively
Block stubs, TODOs, and deferred work before edits reach disk with PreToolUse hooks
Run multi-agent workflows with cost-tiered models and independent Opus review gates
Manage spec-driven tasks with mandatory docs, tests, and verify steps via MCP server
Source
Get it from source
Spark does not host a copy of it.
Open sourceReports
Agent outcome reports
No reports yet
Overview
Rulebook
Rulebook is a tool-agnostic AI development framework that generates AGENTS.md, quality gates, spec-driven tasks, and an MCP server from one source, read natively by Claude Code, Cursor, Codex, Gemini, and Copilot. Opt-in workflows loop a task backlog through implementation and an independent, diff-only review gate before merge. Use it when multiple AI coding agents need to share the same project rules and a real spec-and-review workflow instead of per-tool configuration. Not a fit for teams wanting zero process overhead, since it still enforces structural rules against stubs and deferred TODOs.
What it does
Rulebook is a tool-agnostic AI development framework: one init command generates AGENTS.md, the format Claude Code, Cursor, Codex, Gemini, and Copilot all read natively, plus quality gates, spec-driven task management, and an MCP server, with 28 languages auto-detected. Its v7 rewrite cut session overhead from roughly 15k tokens to about 3.4k, consolidated its MCP surface to six action-parameterized tools, and reduced enforcement to one path-only guard hook with full-autonomy permissions - orchestration features like subagents and parallelism are available but never mandated or blocking.
When to use - and when NOT to
Use it when multiple AI coding agents or tools need to follow the same project rules from one source instead of per-tool adapters, especially on teams running spec-driven development with a real review gate before code merges. rulebook-driver and its sibling workflows loop a task backlog through implementation and an independent opus-model review that sees only the diff and the spec, with no developer context, so the gate is a genuine second opinion rather than a rubber stamp. It is not a fit for a team that wants zero process overhead - even in its leanest mode it still enforces structural rules like "no TODO/deferred markers in tasks.md" and blocks manual task-file creation before an edit reaches disk.
Capabilities
Tasks are spec-driven and OpenSpec-compatible: each gets a proposal.md, tasks.md, and specs/ with SHALL/MUST requirements and Given/When/Then scenarios, phase-prefixed IDs, and a mandatory docs-and-tests tail before archiving. The default task backend is local directories under .rulebook/tasks/, but projects running several agents at once can switch to GitHub issues instead, so parallel agents in separate worktrees or on other machines coordinate through a shared store rather than conflicting on files. Six MCP tools cover tasks, memory (knowledge, decisions, learnings), session start/end, skills, rules, and multi-project workspace status, all routed automatically by file path in monorepo setups discovered from pnpm-workspace.yaml, turbo.json, nx.json, or similar. Opt-in Claude Code workflows (rulebook-driver, spec-author, feature-pipeline, bugfix, review-fanout, release-gate) fan work across cost-tiered models - haiku for read-only steps, sonnet for implementation, opus for the final review or go/no-go gate.
How to install
npx @hivehub/rulebook@latest init
npx @hivehub/rulebook@latest claude
init auto-detects languages and sets up rules, quality gates, and the MCP server; claude applies the recommended Claude Code setup - MCP entry, one path-only PreToolUse guard hook, full-autonomy permissions, a status line - idempotently and non-destructively, preserving any settings you already have. rulebook mcp init wires the MCP server into .mcp.json with zero further configuration. Install globally with npm install -g @hivehub/rulebook to use the rulebook command directly; it requires Node.js 20+ and is Apache 2.0 licensed.
Who it's for
Teams running multiple AI coding agents against the same codebase who want one shared rule set, a real spec-and-review workflow, and structural guardrails against shortcuts like stub code or deferred TODOs, without maintaining a separate configuration per tool.
Source README
@hivehub/rulebook
Tool-agnostic AI development framework. One
initgeneratesAGENTS.md- the universal standard every AI coding agent reads - plus Claude Code integration, quality gates, spec-driven task management, and an MCP server. Auto-detects 28 languages.
v7 - built to assist frontier models, never to anchor them. ~3.4k tokens of
session overhead (was ~15k in v6, −77%), 5 consolidated MCP tools, one
path-only guard hook, zero permission prompts for routine work, and
orchestration (subagents/parallelism/teams) that is never blocked or mandated.
Measured, budgeted in CI, and documented indocs/analysis/v7-performance/.
Upgrading from v6? See the
migration guide - update --dry-run
shows the plan first.
Quick Start
# Initialize — auto-detects languages and sets up rules, gates, and MCP
npx @hivehub/rulebook@latest init
# Update an existing project to the latest rules
npx @hivehub/rulebook@latest update
# Apply the recommended Claude Code setup (MCP, permissions, statusline)
npx @hivehub/rulebook@latest claude
Then, inside Claude Code, spec a feature and let the backlog implement itself
(workflows are opt-in - rulebook claude --workflows installs them):
/spec rate-limit the public REST API # asks questions, creates rulebook tasks
/rulebook-driver # implements every task, opus review gate
Install globally with
npm install -g @hivehub/rulebookto userulebookdirectly.
Why Rulebook
AI coding agents produce inconsistent, error-prone code without clear guidelines. Rulebook gives every agent the same rules from a single source of truth - and stays tool-agnostic by generating the AGENTS.md standard that Claude Code, Cursor, Codex, Gemini, Copilot, and other agents read natively. No per-tool adapters to maintain.
| What | How |
|---|---|
| Universal rules | AGENTS.md + CLAUDE.md generated from one source - read natively by any AGENTS.md-aware agent |
| Quality gates | Pre-commit (lint, type-check, format) + pre-push (build, tests) hooks - language-aware, cross-platform |
| Spec-driven tasks | OpenSpec-compatible tasks with a docs + tests tail - check it or archive with a one-line waiver |
| 6 MCP tools | rulebook_task / _memory / _session / _skill / _rules / _workspace - action-parameterized, ~3.6 KB of schemas total |
| Lean by design | One path-only guard hook, full-autonomy permissions, no content regexes, no ceremony for small fixes |
| 28 languages | Auto-detected with confidence scores; language-specific templates and CI/CD workflows |
Core Features
Modular rules
Rulebook generates a thin @import chain instead of one massive file:
CLAUDE.md (thin, ~100 lines)
@imports AGENTS.md — team-shared rules
@imports AGENTS.override.md — your project overrides (survives updates)
@imports .rulebook/STATE.md — live task/health status
@imports .rulebook/PLANS.md — session scratchpad
AGENTS.md is the portable, tool-agnostic output. Path-scoped rules in .claude/rules/ load only when the agent touches matching files (e.g. TypeScript rules for .ts files). A small set of always-on rules enforce core behaviors: diagnostic-first, fail-twice-escalate, no-deferred, no-shortcuts, sequential-editing.
Task management
Spec-driven development in an OpenSpec-compatible format - phase-prefixed task IDs, a mandatory tail (docs + tests + verify), and automatic archival.
rulebook task create phase1_add-auth # Create task with structure
rulebook task list # See pending work
rulebook task validate phase1_add-auth # Check format
rulebook task archive phase1_add-auth # Archive when done
Each task gets proposal.md (why), tasks.md (checklist), and specs/ (SHALL/MUST requirements with Given/When/Then scenarios).
Task backend: files (default) or GitHub issues
By default tasks are directories under .rulebook/tasks/. Projects running
several agents at once can switch to GitHub issues instead, where one issue is
one task:
// .rulebook/rulebook.json
{ "tasks": { "backend": "github", "repo": "owner/name", "label": "rulebook-task" } }
The commands above and the rulebook_task MCP tool are unchanged - they talk
to whichever backend is configured, and agents can equally drive gh directly.repo is optional (gh infers it from the remote).
Why switch: GitHub is a shared store, so parallel agents - including ones in
separate worktrees or on other machines - coordinate without conflicting on
task files. Progress renders natively in the issue, and task state cannot
diverge between branches because it does not live in the repo.
What moves into the issue: proposal.md, tasks.md, design.md and anyspecs/<module>/spec.md become marked sections of the issue body. Status maps
to a rulebook-status:<state> label, and archiving closes the issue. Project
specs under .rulebook/specs/ stay on disk either way.
Requires gh on PATH and authenticated (gh auth login); rulebook says so
plainly rather than failing obscurely if it is missing.
Knowledge, decisions & learnings
Lightweight, file-based project memory - plain markdown, searchable, committed with your repo.
rulebook knowledge list # patterns and anti-patterns
rulebook decision list # architecture decision records
rulebook learn list # captured implementation learnings
Structural enforcement
A single PreToolUse hook blocks forbidden patterns at the tool level - before edits reach disk: deferred/skip/later/TODO in tasks.md, stubs/placeholders/HACK/FIXME in source, and manual task-file creation in .rulebook/tasks/. Cross-platform (Node.js, no jq dependency), and short-circuits in pure bash so a normal edit costs ~one process spawn.
Multi-project workspace
One MCP server manages every project in a monorepo, with fully isolated per-project managers.
rulebook workspace init # Create workspace config
rulebook workspace add ./frontend # Add projects
rulebook mcp init --workspace # Single MCP for all
Auto-discovers from pnpm-workspace.yaml, turbo.json, nx.json, lerna.json, or *.code-workspace.
Multi-Agent Workflows
Orchestrated Claude Code Workflow scripts are opt-in (agents and workflows no longer install by default - native harness agents cover the roles). When installed into .claude/workflows/, each fans work across bundled agents with cost-tiered models - haiku for read-only steps, sonnet for implementation, opus for the final review gate.
| Workflow | What it does |
|---|---|
rulebook-driver |
Loops the backlog: next unchecked item → implement (SDD+TDD) → independent opus review gate (≤3 rounds) → document → next |
spec-author |
Research → draft proposal + SHALL/MUST spec → opus gap-critic returns ranked questions + gaps |
feature-pipeline |
research → architect (opus) → implement → test → opus review → document |
bugfix |
root-cause → TDD fix → opus quality-gatekeeper verdict (≤2 rounds) |
review-fanout |
Adversarial multi-dimension review of the diff, each finding verified, opus synthesis |
release-gate |
Parallel build / tests+coverage / security / docs → single go/no-go |
The independent reviewers run as fresh subagents with no developer context - they see only the git diff plus the spec, so the gate is a genuine second opinion.
/rulebook-driver # drain the whole backlog
/spec-author { "topic": "rate-limit the public API" }
/review-fanout # reviews the current git diff
/release-gate # go/no-go before a release
Claude Code Setup
rulebook claude applies the recommended Claude Code setup in one idempotent, non-interactive step.
rulebook claude # apply the recommended setup
rulebook claude --model opus # same, but set the default model (default: sonnet)
It installs the MCP server entry and the Rulebook-specific skills, then layers the v7 .claude/settings.json (agents/workflows are opt-in):
| Applied | Detail |
|---|---|
| Hook | ONE path-only PreToolUse guard protecting task scaffolding - nothing on Stop/UserPromptSubmit/SessionStart, no content regexes |
| Full-autonomy permissions | defaultMode: acceptEdits + broad allow list (Bash/Edit/Write/Agent/WebFetch/…) - ~0 permission prompts for routine work |
statusLine |
project dir + git branch + context meter (ctx NN%) |
model |
cost-aware default (sonnet) |
All settings are additive and non-clobbering - existing permissions.allow, a user-authored statusLine, and an explicit model are preserved. Requires Claude Code installed (~/.claude); otherwise it no-ops with a notice.
MCP Server
MCP tools over stdio transport. Zero configuration after rulebook mcp init.
rulebook mcp init # One-time setup — configures .mcp.json automatically
| Tool | Actions |
|---|---|
rulebook_task |
create · list · show · update · archive (tailWaiver) · validate · delete |
rulebook_memory |
knowledge / learnings / decisions × add · list · show · update · promote |
rulebook_session |
start (plans + tasks + learnings in ONE call) · end (rotating history) |
rulebook_skill |
list · show · search · enable · disable · validate |
rulebook_rules |
list project rules |
rulebook_workspace |
list · status · tasks (workspace mode only) |
Workspace routing is automatic: pass any file path and the server resolves
the owning project (explicit projectId overrides).
CLI Reference
# Project setup
rulebook init # Interactive setup (auto-detects everything)
rulebook init --minimal # Essentials only
rulebook init --lean # AGENTS.md as a <3KB index
rulebook update # Update to the latest rules
rulebook doctor # Health checks (file sizes, broken imports, stale state)
rulebook claude # Apply the recommended Claude Code setup
# Tasks
rulebook task create <task-id> # Create (phase-prefixed: phase1_add-auth)
rulebook task list # List active tasks
rulebook task archive <task-id> # Archive a completed task
# Knowledge / decisions / learnings
rulebook knowledge list
rulebook decision list
rulebook learn list
# Workspace
rulebook workspace init
rulebook workspace add <path>
rulebook workspace status
# CI/CD & quality
rulebook workflows # Generate GitHub Actions
rulebook check-coverage # Check test coverage
rulebook version <major|minor|patch>
Supported Languages
TypeScript, JavaScript, Python, Rust, Go, Java, Kotlin, C, C++, C#, PHP, Ruby, Swift, Elixir, Dart, Scala, Haskell, Julia, R, Lua, Solidity, Zig, Erlang, Ada, SAS, Lisp, Objective-C, SQL - auto-detected with confidence scores, each with language-specific templates and CI/CD workflows.
Configuration
All config lives in .rulebook/rulebook.json:
{
"version": "6.0.0",
"mode": "full",
"features": {
"gitHooks": true,
"templates": true,
"parallel": true,
"smartContinue": true
}
}
Key files generated by Rulebook:
| File | Purpose |
|---|---|
AGENTS.md |
Team-shared, tool-agnostic AI rules (regenerated on update) |
AGENTS.override.md |
Your project overrides (survives updates) |
CLAUDE.md |
Claude Code entry point with @imports |
.claude/rules/ |
Path-scoped rules (language-specific + always-on) |
.claude/settings.json |
The quality-enforcement hook + permissions for Claude Code |
.rulebook/tasks/ |
Active task directories |
.rulebook/STATE.md |
Machine-written live status |
Documentation
Full documentation in /docs:
- Usage Examples - end-to-end flows for every workflow
- Getting Started
- Best Practices
See the full CHANGELOG for version history.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.