![\"Anvil](\"docs/public/anvil-social-card.png\")
\r\n \r\n\r\n \r\n \r\n \r\n
\r\n ![\"CI\"](\"https://github.com/BrokkAi/anvil/actions/workflows/ci.yml/badge.svg\"){kind=icon}
\r\n ![\"Latest](\"https://img.shields.io/github/v/release/BrokkAi/anvil\")
![\"crates.io\"](\"https://img.shields.io/crates/v/brokk-anvil\")
![\"LGPL-3.0-only\"](\"https://img.shields.io/github/license/BrokkAi/anvil\")
\r\n Quickstart ·\r\n Documentation ·\r\n Ten-minute evaluation ·\r\n Discord\r\n
\r\n\r\nAnvil is a Rust [Agent Client Protocol](https://agentclientprotocol.com/) server: one reusable agent engine for editors, bots, TUIs, and internal tools.\r\n\r\nIt is intentionally **just the ACP server**. Anvil owns model routing, the tool loop, permission enforcement, sessions, context compaction, sandboxing, and MCP integration. The ACP client owns the user experience.\r\n\r\n```text\r\nACP client stdio / JSON-RPC Anvil\r\n---------- ---------------- -----\r\nZed -----------------------------------------> agent loop\r\nJetBrains ---------------------------------------> model routing\r\nissue bot ---------------------------------------> permission gate\r\ncustom TUI ---------------------------------------> tools + sessions\r\n```\r\n\r\n## Why Anvil\r\n\r\n- **One engine, many frontends.** Reuse the same execution semantics from a supported editor or any ACP-over-stdio client.\r\n- **Model routing built in.** Connect Codex/ChatGPT, Meta/Muse, Bedrock, Ollama, ds4, DeepSeek, Kimi, Grok, OpenAI-compatible providers, or OpenRouter.\r\n- **Real agent tooling.** Filesystem and shell tools, managed Bifrost code intelligence, MCP servers, skills, plugins, and subagents.\r\n- **Explicit safety boundaries.** Clients choose permission behavior while Anvil applies permission gates, workspace path checks, and the configured sandbox strategy.\r\n- **Persistent work.** Load and resume sessions with durable history, usage reporting, and context compaction.\r\n\r\n## Python inference client\r\n\r\n`uv add brokk-anvil-client` installs native async Python bindings to Anvil's\r\nstandalone model client. It shares provider authentication, structured output,\r\nand retries with `anvil infer`, without an agent session or subprocess.\r\nSee [Python LLM Client](https://anvil.brokk.ai/python-client/).\r\n\r\n## Install and Evaluate\r\n\r\nInstall the released native binary through [uv](https://docs.astral.sh/uv/),\r\nwith no Rust toolchain required:\r\n\r\n```bash\r\nuv tool install brokk-anvil\r\nanvil --version\r\n\r\n# later\r\nuv tool upgrade brokk-anvil\r\nuv tool uninstall brokk-anvil\r\n```\r\n\r\nThe Python package version pins the matching GitHub release. On first run it\r\ndownloads the native archive for macOS, Linux glibc, Windows, or\r\nAndroid/Termux, verifies the published SHA-256 sidecar, and caches the binary.\r\nSee the [installation guide](https://anvil.brokk.ai/install/#uv) for exact\r\nversion pins, cache paths, and unsupported-platform behavior.\r\n\r\nOr install with Homebrew on macOS (Apple Silicon and Intel) or Linux (x86-64\r\nand ARM64 glibc):\r\n\r\n```bash\r\nbrew install brokkai/tap/anvil\r\nanvil --version\r\n```\r\n\r\nOr install through npm on any supported platform (macOS, Linux glibc, Windows, Android/Termux) — the package installs the released native binary, no Rust toolchain needed:\r\n\r\n```bash\r\nnpm install -g @brokkai/anvil\r\nanvil --version\r\n\r\n# or run one-shot without installing\r\nnpx -y @brokkai/anvil --version\r\n```\r\n\r\nOr install the latest checksum-verified release on macOS, Linux, WSL, or Android/Termux:\r\n\r\n```bash\r\ncurl -fsSL https://raw.githubusercontent.com/BrokkAi/anvil/refs/heads/master/install.sh | bash\r\nanvil --version\r\n```\r\n\r\nTo review the installer before running it, download `install.sh`, inspect it, then run it with `bash`. You can also download an archive from [GitHub Releases](https://github.com/BrokkAi/anvil/releases/latest), or install from crates.io:\r\n\r\n```bash\r\nrustup target add wasm32-wasip2\r\ncargo install brokk-anvil --locked --force\r\nanvil --version\r\n```\r\n\r\nRunning `anvil` directly starts a stdio JSON-RPC server; use it through an ACP client. Continue with the [installation guide](https://anvil.brokk.ai/install/) or the reproducible [ten-minute evaluation](https://anvil.brokk.ai/evaluate-anvil/).\r\n\r\nFor scripts, CI jobs, and Makefiles, `anvil --print` runs one prompt headlessly with a built-in ACP client and exits — no external client required:\r\n\r\n```bash\r\nanvil -p \"summarize the failing test\" # prompt as an argument\r\necho \"fix this test\" | anvil -p # or on stdin (also: anvil -p -)\r\nanvil -p \"…\" --output-format json # one JSON object at exit\r\nanvil -p \"…\" --output-format stream-json # newline-delimited records, result last\r\nanvil -p \"…\" --permission-mode yolo # manual (default) | auto | yolo\r\nanvil -p \"…\" --cwd /path/to/repo --model \"codex::gpt-5-codex+high\"\r\nanvil -p \"…\" --resume SESSION_ID # continue an existing session\r\n```\r\n\r\nHeadless runs never block on a human: `manual` rejects every permission request but still honors agent-side approvals that never reach the client (`read`, `search`, and `fetch`; sandboxed shell commands on the conservative read-only safelist; and remembered repo-scoped **Always allow** grants); `auto` accepts edit/delete/move but rejects shell execution; and `yolo` accepts everything. The final assistant message goes to stdout (`text`), or a machine-readable payload with `session_id`, `resumed`, `result`, `stop_reason`, `usage`, and `error` (`json` / `stream-json`); progress and diagnostics stay on stderr, and the exit code is non-zero on agent or transport failure ([#356](https://github.com/BrokkAi/anvil/issues/356)).\r\n\r\n`anvil serve` (included in all official binaries; source builds can opt out with `cargo build --no-default-features --features wasm-sandbox`) starts the same runtime as an HTTP daemon on a loopback listener (default `127.0.0.1:26845`), exposing versioned REST endpoints for session lifecycle, model discovery, the tool catalog, and asynchronous prompt runs with Server-Sent-Event streaming and cancellation (`/health`, `/v1/models`, `/v1/tools`, `/v1/sessions`, `/v1/runs`). The daemon supports bearer-token authentication (required for non-loopback binding), server-enforced workspace roots, and interactive permission approval endpoints. The wire contract is versioned and checked in under [`openapi/`](openapi/) (OpenAPI document, SSE event schema, and compatibility policy), with a black-box conformance suite holding the implementation to it. Generate a client in your preferred language from those contract files.\r\n\r\nConfigure a supported ACP client directly from the installed binary:\r\n\r\n```bash\r\nanvil install zed\r\nanvil install jetbrains\r\nanvil install neovim --plugin codecompanion\r\n```\r\n\r\n## Supported Clients\r\n\r\n- [Zed](https://anvil.brokk.ai/zed/), [JetBrains](https://anvil.brokk.ai/jetbrains/), and [Neovim](https://anvil.brokk.ai/neovim/) have direct installers and verified configuration shapes.\r\n- [Other ACP clients](https://anvil.brokk.ai/other-acp-clients/) can launch Anvil as a custom stdio agent.\r\n- The [client-building guide](https://anvil.brokk.ai/build-acp-client/) and `examples/` show issue triage, review, and issue-drafting automations.\r\n\r\n## Documentation and Development\r\n\r\nThe [Anvil documentation](https://anvil.brokk.ai/) is the canonical user reference for providers, commands, tools, permissions, sessions, extensibility, and trust boundaries.\r\n\r\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for source development, runtime invariants, tests, dependency-license policy, pull requests, and releases.\r\n\r\n## License\r\n\r\nAnvil is licensed under `LGPL-3.0-only`. See the practical [License and Use Cases](https://anvil.brokk.ai/license-use-cases/) guide, the controlling [LICENSE](LICENSE), and [third-party notices](https://anvil.brokk.ai/third-party-notices/).\r\n","readmeFilename":"README.md"}