AutoformBot is a coding-agent plugin and Python CLI for Lean 4 formalization
projects. It builds source-grounded Markdown roadmaps, validates dependencies,
publishes progress views, and prepares human or agent review. The plugin and
CLI use the identifier autoform; the canonical repository is
facebookresearch/autoform-bot.
The default main branch provides repository setup, roadmap planning,
publication, human and agent review, and shared Lean LSP/REPL tools. It does
not include autonomous orchestration.
Autonomous execution is an opt-in overlay on the
execution
branch. It adds orchestration, claim-backed workers, specialist agents, and
prover adapters on top of main. Use main unless you are explicitly
evaluating that execution stack.
- Python 3.10 or newer and
uv - Git
- Lean and Lake for Lean tooling and verification
- Claude Code or Codex for the installation flows below
Claude Code:
claude plugin marketplace add facebookresearch/autoform-bot
claude plugin install autoform@autoformCodex:
codex plugin marketplace add facebookresearch/autoform-bot --ref main
codex plugin add autoform@autoformStart a new agent session so the skills and MCP servers reload. A native Muse manifest is included, but Muse installation is not covered here.
Work from an existing Lean repository and use the host skills from its agent window. The skills invoke Autoform's CLI themselves; users do not need to learn or run its commands.
| Task | Claude Code | Codex |
|---|---|---|
| Set up the blueprint and publication files | /autoform:setup |
$setup |
| Build a source-grounded roadmap | /autoform:roadmap |
$roadmap |
| Prepare a person-led review | /autoform:human-review |
$human-review |
| Run an independent agent review | /autoform:agent-review |
$agent-review |
For example: “Build a complete roadmap for Sections 2–4 of paper.pdf.” Keep
the source in the repository or provide an accessible path. Roadmap treats
coarse planning as an internal checkpoint unless staged review was requested;
when possible, the skill uses a compatible model-callable Goal itself. Human
and agent review remain available before execution.
blueprint/
├── README.md
├── coverage/README.md
├── roadmap/
│ ├── README.md
│ └── convexity/
│ ├── README.md
│ ├── convex.md
│ └── separating-hyperplane.md
└── sources/paper.md
Every Markdown file below blueprint/roadmap/ is an article. A nested
README.md represents its directory and contains the articles below it.
Optional declaration: theorem, declaration: def, and similar frontmatter
marks a formalizable article. Inline relative links under ## Depends on and
## Proof depends on define dependency edges; reference-style links do not.
Markdown is the source of truth; Mermaid graphs and MkDocs pages are derived views. See the blueprint format and CLI reference for complete frontmatter, hierarchy, status, and validation rules.
Skills use these commands to make and verify changes. They are documented for plugin development and debugging, not as a required user workflow.
| Command | Purpose |
|---|---|
autoform init |
Scaffold the blueprint and site; add CI when immutably pinned. |
autoform check |
Validate Markdown structure and dependencies. |
autoform audit |
Audit completeness and checked facts. |
autoform doctor |
Diagnose the local blueprint contract. |
autoform skeleton |
Extract what a reader must trust for each formalized statement. |
autoform claim |
Coordinate temporary ownership through Git refs. |
autoform render |
Generate publishable MkDocs source. |
autoform-visualize |
Generate the Mermaid dependency graph. |
Inside an Autoform checkout, use uv run:
uv run autoform check /path/to/project/blueprint --lean-root /path/to/project
uv run autoform-visualize /path/to/project/blueprint
uv run autoform render /path/to/project/blueprint \
--output /path/to/project/site-src \
--lean-root /path/to/project --require-declarationsFrom a consumer project, resolve the installed plugin root and prefix commands
with uv run --project "<AUTOFORM_PLUGIN_ROOT>", or separately install the
Python package so its console scripts are on PATH.
check --lean-root lexically resolves names in local Lean files; it does not
compile them or prove that they belong to a Lake target. Use lake build and
the verification workflow for compilation and audit, while treating the
blueprint-to-declaration match as a separate contract.
render writes MkDocs source, not a deployed site. The generated Pages workflow
deploys from main only after GitHub Pages is enabled in repository settings.
Development also requires Make:
git clone https://github.com/facebookresearch/autoform-bot.git
cd autoform-bot
make setup
make lint
make test
make check-exampleClaude Code uses /autoform:develop-plugin; Codex uses $develop-plugin.
make check-example validates, renders, and builds the example documentation.
Run lake build in the Cabannes fixture when changing its Lean sources or
declarations.
AutoformBot is released under the MIT License.