Generated banner for Writing Lean Proofs
Generated logo for Writing Lean Proofs

Writing Lean Proofs

Trail of BitsOfficialPublished by Trail of Bits

  • Skill
  • Tool integration
  • Software development
  • CC-BY-SA-4.0
  • No issues found

From the author

Writes and reviews structured Lean 4 proofs and designs Lean libraries following Mathlib conventions. Use when proving theorems in Lean, formalizing mathematics or specifications in Lean 4, defining new types or definitions in a Lean library, reviewing Lean proofs for readability and maintainability, refactoring long tactic proofs into lemmas, filling in sorry placeholders in a Lean development, setting up CI or linters for a Lean project, diagnosing slow proofs or maxHeartbeats timeouts, or writing custom tactics, macros, or linters.
— the description by Trail of Bits

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a rigorous methodology for formalizing mathematics and software specifications in Lean 4. It emphasizes a top-down design approach where definitions and API statements are established before proofs are written. By treating statements as stable interfaces and proofs as disposable, it enables scalable, parallel development. The skill covers the entire lifecycle of a Lean project, from initial sorry-based skeleton construction and API design to mechanical verification, linter configuration, and performance optimization.

What it does

  • Provides patterns for designing Lean 4 libraries and definitions.
  • Outlines a top-down workflow for building proof skeletons with sorry placeholders.
  • Defines best practices for proof structure, including calc blocks and focusing.
  • Details strategies for mechanical verification and CI integration.
  • Offers guidance on diagnosing performance issues and maxHeartbeats timeouts.
  • Provides rules for writing custom linters and macros.

When to use it

  • When starting a new formalization project in Lean 4.
  • When refactoring long, fragile tactic proofs into maintainable lemmas.
  • When designing new types or structures for a Lean library.
  • When setting up CI pipelines and linters for Lean projects.
  • When diagnosing slow proofs or unexpected timeouts.

Advantages

  • Promotes highly maintainable and readable proof code.
  • Enables parallel development through independent sorry-based work units.
  • Reduces technical debt by enforcing API-first design.
  • Provides clear, actionable criteria for proof extraction and refactoring.
  • Ensures project stability through automated linter and axiom verification.

Usage examples

“How should I structure a new Lean 4 library for group theory?”
The agent will advise defining the structures first, bundling properties using FunLike or SetLike, and writing the full API (ext, simp, coercion lemmas) in the same file before implementing any theorems.
“My proof is failing with a maxHeartbeats timeout. How do I fix it?”
The agent will guide you to measure the cost using #count_heartbeats, suggest decomposing the goal into smaller lemmas, or optimizing the definition's reduction behavior rather than simply increasing the budget.
“How can I ensure my Lean project is ready for multiple contributors?”
The agent will recommend creating a sorry-based skeleton, setting up a leanblueprint for dependency tracking, and configuring a strict CI environment with project-specific linters.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/trailofbits/writing-lean-proofs/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip writing-lean-proofs.zip -d .agents/skills

Documentation by Trail of Bits

Writing Lean Proofs

Contents

  • When to Use

  • When NOT to Use

  • The workflow

  • The extraction ladder

  • Quick reference

  • Rationalizations to reject

  • References

Structured Lean 4 proof writing and library design, distilled from Mathlib's style and review conventions and from the methodology of large formalization projects (Liquid Tensor Experiment, PFR, Fermat's Last Theorem).

Core principle: design top-down, prove bottom-up. Lean propositions are proof-irrelevant — only a theorem's statement can affect later declarations. Statements are the stable interface; proofs are disposable and freely replaceable. Put design effort into definitions and statements, then fill in proofs against skeletons that already compile (modulo sorry).

When to Use

  • Proving theorems in Lean 4, from single lemmas to multi-file developments

  • Formalizing mathematics, protocols, or software specifications in Lean

  • Defining new types, structures, or functions in a Lean library

  • Reviewing Lean code for readability, maintainability, or Mathlib readiness

  • Refactoring a long or fragile tactic proof into lemmas

  • Setting up a formalization project that several people or agents will contribute to in parallel

  • Setting up CI, linters, or verification gates for a Lean project — do this at project start, before patterns propagate

  • Diagnosing slow proofs, maxHeartbeats timeouts, or expensive reduction

  • Writing custom tactics, macros, or project-specific linters

When NOT to Use

  • Lean 4 as a general-purpose programming language (no proofs involved) — most of this skill targets proof and API structure

  • Coq, Isabelle, Agda, or Lean 3 — conventions and tactic names differ; Lean 3 idioms (ge_or_gt linting, discrete_field) are obsolete

  • Verified-software Lean projects with their own house style (e.g. spec-traceability-first codebases): Mathlib conventions are the community default, but check the project's CONTRIBUTING first and defer to it

The workflow

1. Design definitions and their API first

Definitions carry the design weight. Before proving anything about a new concept:

  • Prefer total functions with junk values over subtypes or Option in signatures (Mathlib: (0 : ℝ)⁻¹ = 0). Side conditions then appear only on the lemmas that need them, not at every use site.

  • Bundle: new morphism kinds are structures with a FunLike instance; new subobject kinds use SetLike; carry property proofs as structure fields, not separate IsHom-style predicates.

  • Pick the canonical spelling (simp-normal form) for every concept with multiple equivalent forms, and state all API lemmas for that form only.

  • Write the API in the same file, immediately: ext, @[simp], coercion, and injectivity lemmas — before the definition is used anywhere. Downstream proofs use the API, never unfold/show ... from rfl.

See library-design.md for the full set of design rules with rationale.

2. Build a sorry skeleton

State everything before proving anything, at every scale:

  • Project scale: state the target theorem and the lemmas it needs, all with := sorry, and make the file compile. Each sorry is now an independent work unit — a contributor (human or LLM) can discharge one without understanding the rest. This is how LTE, PFR, and FLT scale to dozens of parallel contributors.

  • Proof scale: inside a proof, lay out the have/suffices/calc skeleton with sorry justifications, get Lean to accept the structure, then fill each step. Keeping the structure intact is what produces useful error messages while you work.

example (a b c d : ℝ) (h : c = d * a + b) (h' : b = a * d) : c = 2 * a * d := by
  calc
    c = d * a + b     := sorry
    _ = d * a + a * d := sorry
    _ = 2 * a * d     := sorry
3. Fill goals, one focused goal at a time
  • Every new subgoal gets a focusing dot · with an indented block — never leave several goals active in unfocused sequence (Mathlib's multiGoal linter enforces this). This is what kills fragile goal-ordering dependence.

  • Open each block with a redundant show stating its goal. The proof works without it; reviewers and future editors need it. If show would change the goal, use change instead — keep stated goals honest.

  • Chained rewrites of (in)equalities become calc blocks, relations aligned vertically.

  • have for forward stepping stones ("we first establish X"); suffices for backward reduction ("it suffices to show X").

  • While drafting, annotate the goal state as a comment before non-obvious tactics — emitted by Lean, never imagined. In a headless workflow, insert trace_state at the point of interest or a deliberate done where goals should be closed, then run lake env lean Path/To/File.lean; copy the reported hypotheses, case name, and target. Strip routine probes after the proof works. This is the single most effective technique for LLM-written proofs (see llm-techniques.md).

See proof-style.md for the full tactic-style rules, and naming-conventions.md for naming lemmas so their names are guessable from their statements.

4. Verify mechanically

Do not eyeball-check style — run the checkers. lake build is the floor, and it is only the floor: sorry is a warning, so a green build exits 0 with sorries still present.

  • Gate unproved obligations by asking the kernel, never by grepping. #print axioms myTheorem for a spot check; for CI, collect axioms per declaration with Lean.collectAxioms and assert the whole expected footprint ([propext, Classical.choice, Quot.sound] unless deliberately widened), so a stray sorry or a new trust assumption like native_decide fails loudly. Grep is wrong in both directions: it matches the word in comments, and it misses a theorem whose own text is clean but which applies an unproved helper. Working script in linting.md.

  • Choose lints by project role and put them in CI at project start. Do not enable linter.mathlibStandardSet wholesale in a downstream project: it combines proof-maintenance checks with public-API checks, house style, and Mathlib-specific repository policy. For a self-contained proof, start with linter.auxLemma, linter.style.maxHeartbeats, linter.style.multiGoal, linter.style.setOption, and linter.style.show. A reusable library should additionally enable linter.flexible, linter.style.missingEnd, linter.style.openClassical, and the two unused*InType checks. Treat nativeDecide as a trust-policy choice and formatting or deprecated-syntax checks as project style. No warning gates anything unless warnings fail the build. Run Batteries' declaration-level #lint checks, including simpNF, separately. Verify every option against the pinned Mathlib source and with a known-trigger fixture: a misspelled weak. option is intentionally ignored. The complete 26-member audit and lakefile profiles are in linting.md.

  • Write a custom linter for every project-specific convention (simp-set discipline, summary-lemma coverage, required attributes) — a declaration-level @[env_linter] is one structure, and it is the only thing that reliably catches "the attribute is missing on 29 of 30 declarations". See linting.md for the recipe and the engineering rules (vacuity anchors, prove-it-can-fail, allowlists).

The extraction ladder

When does proof structure graduate into separate lemmas?

  1. Before extracting, state the fragment's type and search by shape. Put the proposed statement in a scratch example, run exact? and apply? on the bare goal, then try a type-pattern and source search. If an existing theorem fits, use it. Do not report an API gap without recording the searches that failed.

  2. A sub-argument repeats within one proof → name it as a local have.

    theorem min_comm (a b : ℝ) : min a b = min b a := by
      have h : ∀ x y : ℝ, min x y ≤ min y x := by
        intro x y
        apply le_min
        · show min x y ≤ y
          exact min_le_right x y
        · show min x y ≤ x
          exact min_le_left x y
      apply le_antisymm
      · show min a b ≤ min b a
        exact h a b
      · show min b a ≤ min a b
        exact h b a
  3. The statement is independently interesting, or extraction sheds hypotheses the sub-argument does not need → standalone lemma. Dropping unneeded hypotheses is the stronger trigger: the extracted lemma becomes more general than the proof it came from.

  4. The proof reads as "long and unwieldy" → split it. This is Mathlib's review criterion, and it is deliberately qualitative — there is no line threshold. Resolve doubt by attempting the extraction: if a fragment has a clean statement, it wanted to be a lemma.

Quick reference

RuleWhyEnforced by
Never unfold definitions downstream; erw or trailing rfl = missing APIAPI lemmas are the abstraction boundaryreview ("missing API" smell)
Terminal simp stays unsqueezed; non-terminal simp becomes simp only [...]squeezed terminal calls bury the key lemmas and break on renamesstyle guide
One focused goal at a time (· blocks)kills goal-ordering fragilitylinter.style.multiGoal
show must not change the goal (use change)stated goals stay honestlinter.style.show
No set_option debug/trace/profiler or unscoped maxHeartbeats in final codedebugging scaffoldinglinter.style.setOption
State lemmas in simp-normal form, < not >simp matches syntacticallysimpNF linter
Golf only when the result is at least as readable; trivial results exemptshort ≠ betterreview
Fact instances are local, never globalglobal instances degrade all typeclass searchreview
Name lemmas from their statements (see naming reference)names become guessable without searchlinter.style.nameCheck catches only __; #lint defsWithUnderscore and review cover more
Search a bare goal by shape before writing a helper or claiming an API gapnames are not always guessable from the targetexact?, apply?, type/source search
Generally one tactic invocation per line; a one-line closing proof is the exceptionpreserves readable proof structure without inventing an absolute rulestyle guide
Gate sorry with collectAxioms/#print axioms, never grepgrep matches comments, misses unproved helpersaxiom audit in CI
Prefer simp-lemma LHSs keyed on structure, not numerals; one spelling per constant2 ^ 32 never matches a goal normalized to 4294967296simpNF, review
Re-derive every simp only list with simp? at its own sitelists do not transfer between look-alike goalslinter.flexible
Every maxHeartbeats override is an unproven claim — measure before believingcopy-pasted budgets carry no information#count_heartbeats, bisection
Conditional simp lemma fires shallow but not deep → raise maxDischargeDepth (default 2)chained side conditions truncate silently, no diagnosticdiagnosis (proof-style, simp discipline)
Every project-specific convention gets a custom linter, in CI from day onereview misses the 29-of-30 failure mode@[env_linter] + #lint

Full rationale for each row, plus the library-level anti-patterns, in anti-patterns.md.

Rationalizations to reject

ExcuseReality
"The proof compiles, ship it"Compiling is the floor. A monolithic tactic block that only Lean can read will break silently at the next Mathlib bump and no one will be able to repair it.
"Unfolding the definition is simpler than writing API lemmas"Every downstream unfold couples a proof to the implementation. The first refactor breaks all of them at once. Write the missing lemma.
"Squeezing every simp makes the proof faster and more robust"Backwards for terminal simp calls: the squeezed list breaks on every rename and drowns the signal. Squeeze non-terminal calls only.
"It's shorter, therefore better"Mathlib review policy: golfing is fine only when it does not sacrifice readability. Length is not the target; legibility is.
"I'll restructure it into lemmas after it works"After it works, the structure is load-bearing and tangled. State the skeleton first; the lemmas fall out for free.
"Adding show lines is redundant noise"They are redundant to the kernel and essential to every human or model that reads the proof next.
"This helper is too specific to be a lemma"If it has a clean statement, extract it — dropping the hypotheses it doesn't need usually reveals it was general all along.
"We'll add linters once the library stabilizes"Backwards: patterns propagate by copy-paste, so a deferred linter meets a 400-warning backlog instead of one bad line. Enable what is already clean and gate it now.
"The check passed, so we're clean"A check that can't fail proves nothing — sweeps reach zero files, misspelled weak. options are ignored, pipelines swallow exit codes. Prove every gate can fail before trusting that it passes.
"The proof is slow, raise maxHeartbeats"An unmeasured budget is a claim, not a fix — and it masks the regression the next reader needs to see. Measure with #count_heartbeats; restructure the definition or decompose the goal.

References

  • library-design.md — definitions, APIs, bundling, abstraction boundaries, spec-driven project decomposition

  • proof-style.md — tactic proof structure: calc, have/suffices, focusing, and simp discipline including the why-doesn't-this-lemma-fire diagnoses (discharge depth, traversal order, numeral spellings)

  • naming-conventions.md — Mathlib naming so lemma names are computable from statements

  • anti-patterns.md — recognized anti-patterns, why each is harmful, and which linter catches it

  • llm-techniques.md — evidence-based techniques specific to LLM-written proofs

  • linting.md — axiom-based sorry gates, enabling project-specific linter profiles in CI early, the full Mathlib standard-set audit, adopting linters with a backlog, writing custom linters for project-specific constructs, and proving every gate can fail

  • performance.md — measuring per-declaration cost, where reduction cost comes from, optimizing definitions without losing semantics

  • tactics.md — metaprogramming discipline: extension-point selection, metavariable and recovery safeguards, bounded search, actionable errors, structured tracing, generated declarations, and failure-surface testing

Files

references/anti-patterns.md

Anti-patterns

Each entry: what it is, why it is harmful (not just that it is), and which mechanism catches it. The meta-lesson from Mathlib's history: review alone does not catch these — the first simp-normal-form linter found over one hundred redundant simp lemmas that had all passed expert maintainer review. Put the check in tooling.

Proof-level

Monolithic tactic blocks

One long unstructured tactic sequence. Harmful because the argument's structure is invisible — the only way to follow it is to replay it in an editor, and the only way to repair it after a library bump is to rebuild it from scratch. Caught by: review ("long and unwieldy" → split). Fix: sorry skeleton first, extraction ladder after.

Unfocused multiple goals

Running tactics while several goals are active, relying on goal order. Harmful because any change to an earlier tactic silently redirects later tactics to different goals. Caught by: multiGoal linter. Fix: · blocks, one per goal.

Squeezed terminal simp

simp only [thirty, lemmas, ...] closing a goal. Harmful because it breaks on any rename among the thirty and hides the one lemma that mattered. Terminal simp calls stay unsqueezed; only non-terminal calls get squeezed (a bare non-terminal simp is the mirror-image anti-pattern: it couples following tactics to the ambient simp set). Caught by: review; the style guide states the rule.

Dishonest show

show that actually changes the goal. Harmful because readers trust show lines as documentation of the goal state; a goal-changing one is documentation that lies. Caught by: show linter. Fix: change.

native_decide in library code

Proves a proposition by compiling it to native code and trusting the result (the Lean.ofReduceBool axiom). Harmful because it silently widens the trust base from the kernel to the entire compiler and runtime; Mathlib disallows it. Caught by: #print axioms (reports Lean.ofReduceBool); Mathlib CI. Fix: decide where the kernel can afford the computation, a certificate-based norm_num proof, or an explicitly documented decision to accept the axiom.

Leftover debugging scaffolding

set_option pp.all true, trace/profiler/debug options, unscoped maxHeartbeats. Harmful as noise and as behavioral drift (heartbeat overrides mask performance regressions). Caught by: setOption linter.

Golfed nontrivial proofs

Compressing a real argument into a one-liner of chained combinators. Harmful because review policy subordinates golfing to readability — the short form is only acceptable when it reads at least as well. Trivial results are the carve-out. Caught by: review.

Non-canonical statements

Stating with > instead of <, or against a concrete spelling instead of the designated simp-normal form. Harmful because simp and every API lemma match syntactically — off-normal statements need duplicate API or never get rewritten. Caught by: simpNF linter (for simp lemmas); review. The numeral special case is easy to miss: a simp lemma keyed on 2 ^ 32 never fires on a goal normalized to 4294967296 — the lemma is true, applicable-looking, and dead. Prefer structural LHS patterns with no numeral at all.

Copy-pasted resource budgets

The same set_option maxHeartbeats N in value on many declarations. Harmful because at that density the annotations carry no information about which proof is actually expensive, and every unmeasured budget masks the regression it was meant to surface — audits have found "6.4M-heartbeat" proofs that run at the default budget once measured. Caught by: #count_heartbeats bisection; Mathlib's maxHeartbeats style linter (which demands a justification comment on every override — the unscoped file-level form is the setOption linter's, see "Leftover debugging scaffolding" above). Fix: measure, keep only the overrides that are real, each scoped to its declaration.

Library-level

Project conventions enforced only by review

A project-specific construct — a simp-set discipline, a required attribute, a coverage rule like "every constructor the executor handles has a soundness lemma" — with no linter behind it. Harmful because the failure mode is forgetting the step on 1 of 30 declarations with no visible symptom, which is precisely what review does not catch (and what models writing Lean get wrong). Caught by: nothing — that is the problem. Fix: a declaration-level @[env_linter] wired into CI's #lint, written alongside the construct, not after the first regression. See linting.md.

Definitional transparency abuse

Downstream proofs that unfold, use erw, or need a trailing rfl to see through a definition. Harmful because each one couples a proof to the implementation; the first refactor breaks them all. The style guide calls this missing API. Caught by: review; the erw/trailing-rfl smell. Fix: add the missing lemma next to the definition.

Definitions without API

A definition used bare, with lemmas about it scattered where they were first needed. Harmful because every user re-derives basic facts, usually by unfolding (see above). Caught by: PR review checklist ("do new definitions come with lemmas about them?"). Fix: same-file ext/simp/coe/injectivity lemmas before first use.

Unbundled predicates for morphisms/subobjects

IsHom f predicates instead of a bundled Hom structure with FunLike. Harmful because instance search cannot reliably discharge IsHom (f ∘ g), and the predicate form forfeits the algebraic structure of the hom-type itself. Caught by: review guide (directs to FunLike/SetLike).

Side conditions instead of junk values

Partial operations via subtypes or hypotheses on the operation rather than junk-value totalization. Harmful because the side condition reappears at every use site ("every step slightly painful" — perfectoid retrospective on the subtype approach). Fix: total function + junk value; hypotheses only on the lemmas that need them.

Global Fact instances

instance : Fact (Nat.Prime 37) at top level. Harmful because every typeclass search everywhere now considers it. Fix: state as lemma, make a local instance where needed.

Premature typeclasses

A new class with no theory behind it. The bar: real mathematics to be done with it, or genuine simplification from a factored substructure. Prefer extends to mixin parameters.

Claims to avoid making

When editing or reviewing, do not cite these as rules — they are commonly repeated but unsupported or wrong:

  • "One tactic per line is an absolute requirement" — Mathlib recommends one tactic invocation per line in general, but explicitly excepts a proof that closes the goal and fits entirely on one line. Apply the recommendation with that exception instead of inventing a hard rule.

  • Any numeric proof-length threshold ("proofs over 20 lines must be split") — the review criterion is deliberately qualitative.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Trail of Bits
Publisher
Trail of Bits (Official)
Source
trailofbits/skills · plugins/writing-lean-proofs/skills/writing-lean-proofs · commit e4dd0bb
Licence
Creative Commons Attribution-ShareAlike 4.0 International (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Trail of Bits or Trail of Bits.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download writing-lean-proofs.zip