agent-gauntlet 0.10.0 → 0.11.0

package/README.md

@@ -11,30 +11,17 @@
 
 Agent Gauntlet is a configurable “feedback loop” runner for AI-assisted development workflows.
 
-You configure which paths in your repo should trigger which validations — shell commands like tests and linters, plus AI-powered code reviews. When files change, Gauntlet automatically runs the relevant validations and reports results.
+You configure which paths in your repo should trigger which validations — shell commands like tests and linters, plus AI-powered local code reviews. When files change, Gauntlet automatically runs the relevant validations and reports results.
 
 For AI reviews, it uses the CLI tool of your choice: Gemini, Codex, Claude Code, GitHub Copilot, or Cursor. 
 
 ## Features
 
 - **Agent validation loop**: Keep your coding agent on track with automated feedback loops. Detect problems — deterministically and/or non-deterministically — and let your agent fix and Gauntlet verify.
-- **Multi-agent collaboration**: Enable one AI agent to automatically request code reviews from another. For example, if Claude made changes, Gauntlet can request a review from Codex or Gemini — spreading token usage across your subscriptions instead of burning through one.
+- **Local cross-agent code reviews**: Enable one AI agent to automatically request code reviews from another. For example, if Claude made changes, Gauntlet can request a review from Codex — spreading token usage across your subscriptions instead of burning through one.
+  - Multiple AI review adapters have been evaluated for quality and efficiency. Claude and Codex deliver optimal review quality with superior token efficiency. For detailed metrics, see [Eval Results](docs/eval-results.md).
 - **Leverage existing subscriptions**: Agent Gauntlet is *free* and tool-agnostic, leveraging the AI CLI tools you already have installed.
-- **Easy CI setup**: Define your checks once, run them locally and in GitHub.
-
-### vs AI Code Review Tools
-
-Unlike traditional code review tools designed for PR workflows, Agent Gauntlet provides real-time feedback loops for autonomous coding agents.
-
-| Use Case | Recommended |
-| :--- | :--- |
-| Autonomous agent development | **Agent Gauntlet** |
-| Traditional PR review with human reviewers | Other tools |
-| IDE-integrated review while coding | Other tools |
-| Enterprise with strict compliance requirements | Other tools |
-| Budget-conscious teams with existing AI CLI tools | **Agent Gauntlet** |
-
-[Full comparison →](docs/feature_comparison.md)
+- **Easy CI setup**: Define your CI gates once, run them locally and in GitHub.
 
 ## Common Workflows
 
@@ -42,15 +29,30 @@ Agent Gauntlet supports three workflows, ranging from simple CLI execution to fu
 
 - **CLI Mode** — Run checks via command line; ideal for CI pipelines and scripts.
 - **Assistant Mode** — AI assistant runs validation loop, fixing issues iteratively.
-- **Agentic Mode** — Autonomous agent validates and fixes in real-time via stop hook.
+- **Agentic Mode** — Autonomous agent validates and fixes in real-time via stop hook (experimental).
 
 ![Agent Gauntlet Workflows](docs/images/workflows.png)
 
-## Quick Start
+### Example Workflow
+
+1. Claude implements a feature
+2. Agent Gauntlet reports quality issues detected by static code analysis and Codex reviewer agent
+3. Claude fixes issues
+4. Agent Gauntlet verifies
+
+### Comparison vs Other Tools
 
-1. **Install**: `bun add -g agent-gauntlet`
-2. **Initialize**: `agent-gauntlet init`
-3. **Run**: `agent-gauntlet run`
+### AI Code Review Tools
+
+Agent Gauntlet is not a replacement for tools that provide AI pull request code reviews. It provides real-time feedback loops for autonomous coding agents, combining deterministic static checks (build, lint, test) with multi-agent AI reviews in a single pipeline. This enables agents to iterate and self-correct until all checks and reviews pass, without human intervention.
+
+[Full comparison →](docs/feature_comparison.md)
+
+### Spec-Driven Workflow Tools
+
+It is recommended to use Agent Gauntlet in conjunction with other spec-driven development tools. We believe is the ideal implementation of the validation step in any Spec → Implement → Validate workflow.
+
+## Quick Start
 
 For basic usage and configuration guide, see the [Quick Start Guide](docs/quick-start.md).
 
@@ -59,7 +61,7 @@ For basic usage and configuration guide, see the [Quick Start Guide](docs/quick-
 - [Quick Start Guide](docs/quick-start.md) — installation, basic usage, and config layout
 - [User Guide](docs/user-guide.md) — full usage details
 - [Configuration Reference](docs/config-reference.md) — all configuration fields + defaults
-- [Stop Hook Guide](docs/stop-hook-guide.md) — integrate with Claude Code's stop hook
+- [Stop Hook Guide](docs/stop-hook-guide.md) — integrate with Claude Code's stop hook (experimental).
 - [CLI Invocation Details](docs/cli-invocation-details.md) — how we securely invoke AI CLIs
 - [Feature Comparison](docs/feature_comparison.md) — how Agent Gauntlet compares to other tools
 - [Development Guide](docs/development.md) — how to build and develop this project