leanwarp 0.2.3__tar.gz

leanwarp-0.2.3/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+dist/
+build/
+.coverage
+.env
+.env.*
+.leanwarp/

leanwarp-0.2.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Isagoge Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

leanwarp-0.2.3/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.5
+Name: leanwarp
+Version: 0.2.3
+Summary: Check and verify Lean proofs on LeanWarp from the command line, MCP or Python
+Project-URL: Repository, https://github.com/Isagoge-Labs/LeanWarp-SDK
+Project-URL: Homepage, https://isagoge.in
+Project-URL: Documentation, https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/README.md
+Project-URL: Issues, https://github.com/Isagoge-Labs/LeanWarp-SDK/issues
+Project-URL: Changelog, https://github.com/Isagoge-Labs/LeanWarp-SDK/releases
+License-Expression: MIT
+License-File: LICENSE
+Keywords: agents,formal-verification,lean,lean4,mathlib,mcp,theorem-proving
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.12
+Requires-Dist: httpcore<2,>=1.0.9
+Requires-Dist: httpx<1,>=0.28.1
+Requires-Dist: mcp<2,>=1.28.1
+Requires-Dist: pathspec<2,>=1.1
+Requires-Dist: pydantic<3,>=2.12
+Provides-Extra: test
+Requires-Dist: pytest<10,>=8.4; extra == 'test'
+Description-Content-Type: text/markdown
+
+<h1><img src="https://raw.githubusercontent.com/Isagoge-Labs/LeanWarp-SDK/main/docs/assets/leanwarp-banner.svg" alt="LeanWarp" width="960"></h1>
+
+LeanWarp checks and verifies Lean 4 proofs on hosted workers that stay warm
+between edits. This SDK is how you and your agents use it: the `leanwarp`
+command, an MCP server and a Python library.
+
+**[Get started](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/getting-started.md)** · [Agent setup](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md) ·
+[Reference](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md) ·
+[HTTP API](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/http-api.md) · [Website](https://isagoge.in/leanwarp)
+
+## What it does
+
+| Operation | What you get | CLI |
+| --- | --- | --- |
+| Check | Lean's errors and warnings for a file; `--draft` reuses Lean's work on the unchanged part while you edit. | `leanwarp check` |
+| Inspect | The goals and local context at a position in a proof. | `leanwarp inspect` |
+| Try tactics | Several tactics from the same captured goal: which close it, which leave goals, which fail. The file is not edited. | `leanwarp try-tactics` |
+| Verify | Whether a declaration proves exactly the statement you give, checked by Lean's kernel. | `leanwarp verify` |
+| Holes | Every `sorry` and `?_` in a file, with its position, and the goals of the first 16. | `leanwarp holes` |
+| Suggest | A tactic that closes a hole, accepted only if nothing else changes and the proof gains no unproved lemma or extra axiom. `apply` writes it into the file. | `leanwarp suggest`, `leanwarp apply` |
+| Sorry to lemma | The proof of each theorem that still has a `sorry` moved into a new named lemma the theorem then uses; the lemma keeps its `sorry`. `apply` writes it. | `leanwarp sorry2lemma` |
+| Declarations | The declarations a file adds, with their types and dependencies. | `leanwarp declarations` |
+| Check files | Up to 64 files checked in one operation. | `leanwarp check-files` |
+
+The [reference](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#commands)
+lists every command and option; `leanwarp skill --reference` prints it.
+
+### Coming soon
+
+These are planned and not available yet:
+
+- **Proof simplification**: replace a proof with a shorter one that still checks.
+- **`have` extraction**: lift named `have` blocks into top-level lemmas.
+- **Batch repair**: fill several holes in one operation.
+
+## Install in two steps
+
+**1. Install.** In a terminal, with [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```sh
+uv tool install leanwarp && leanwarp setup
+```
+
+This installs the `leanwarp` command and its MCP server from
+[PyPI](https://pypi.org/project/leanwarp/). `leanwarp setup` adds the LeanWarp
+skill and MCP server to Claude Code, Codex and Cursor where they are installed,
+and the skill to `~/.agents/skills`. It runs on Linux, macOS and WSL. You don't
+need Lean installed: LeanWarp runs Lean and Mathlib for you.
+
+Or paste this into your agent:
+
+> Install LeanWarp: run `uv tool install leanwarp && leanwarp setup`, then ask me
+> to sign in.
+
+Already have LeanWarp 0.2 from GitHub? Its `leanwarp-sdk` tool owns the
+`leanwarp` command, so replace it instead:
+
+```sh
+uv tool uninstall leanwarp-sdk && uv tool install leanwarp && leanwarp setup
+```
+
+**2. Sign in**, in your own terminal:
+
+```sh
+leanwarp auth login
+```
+
+It opens the dashboard to create an API key; paste the key at the hidden prompt.
+Never paste it into an agent conversation. Then restart your agent.
+
+When a new release is out, results include `update_available`; run
+`leanwarp update` to upgrade and refresh the installed skills.
+
+## Quick start
+
+From your Lean project or one of the [examples](https://github.com/Isagoge-Labs/LeanWarp-SDK/tree/main/examples):
+
+```sh
+leanwarp doctor              # which environment this project runs on
+leanwarp connect             # create the project's workspace
+leanwarp check LeanWarpExample.lean
+```
+
+If a command returns `success: null` (exit `3`), run `leanwarp wait` until it
+finishes before submitting another operation. Then verify:
+
+```sh
+leanwarp verify LeanWarpExample.lean \
+  --declaration add_zero_example --target '∀ n : Nat, n + 0 = n'
+```
+
+Wait for that operation to finish too, then run `leanwarp stop` when you are done.
+
+Every command prints one JSON object. Results start with `success`: `true` when
+the check passed or the proof was verified, `false` when it did not, and `null`
+while the work is still running, in which case run `leanwarp wait`. The exit code
+says the same thing: `0` passed, `1` did not pass, `2` the command failed, `3`
+still running.
+
+## Use with an agent
+
+Give your agent the project directory and this instruction:
+
+> Run `leanwarp skill` and follow it. Use LeanWarp to check this Lean project
+> and verify proofs against their intended statements. Reuse the workspace
+> while you edit, and run `leanwarp stop` when you are done.
+
+For MCP clients, add the server `leanwarp --project /absolute/path/to/project mcp`,
+or `uvx leanwarp --project /absolute/path/to/project mcp`
+without installing. It uses the same key and project state as the CLI. See [agent setup](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md).
+Keep API keys out of prompts, source files and tool arguments.
+
+## Your project and its environment
+
+LeanWarp uploads only your `.lean` files. Lean, Mathlib and every other
+dependency come from an **environment**: a Lean release with Mathlib, already
+built on LeanWarp's workers. Run `leanwarp environments` to list them.
+`leanwarp files` lists what would upload; patterns in `.gitignore` and
+`.leanwarpignore` leave files out.
+
+`leanwarp connect` picks the environment for you:
+
+- If your project's `lean-toolchain` and `lake-manifest.json` match an
+  environment, it uses that one, so results agree with your local build.
+- If your project has neither file, as with a folder of `.lean` files, it uses
+  the only served environment, or the newest served stable Lean release when there are several.
+- If they match no environment, it stops and lists the ones available. Run
+  `leanwarp connect --environment NAME` to check your files there anyway; they
+  then compile against that environment's Lean and Mathlib.
+
+To start a new project, copy one of the [examples](https://github.com/Isagoge-Labs/LeanWarp-SDK/tree/main/examples), which match the
+environments LeanWarp serves.
+
+## Billing
+
+You pay from prepaid credit, billed by the second while a worker runs. Run
+`leanwarp resources` to see the published worker's starting minute price, whether
+charges depend on usage, startup credit hold and idle timeout. LeanWarp selects
+the worker. Use `leanwarp connect --max-spend 2` to create a workspace with a $2
+cap, or edit an existing cap in the dashboard. Reconnecting without a cap keeps
+the saved cap.
+
+When the worker uses usage billing, CPU and RAM charges increase independently
+above their reserved baselines. The starting rate is a paid minimum while the
+worker runs, including idle time. Bursting depends on available host capacity.
+Otherwise, the listed minute rate applies for the time the worker runs. Existing
+workspaces keep their saved billing terms.
+
+A worker starts with your first operation and stays warm between calls. Run
+`leanwarp stop` when finished; closing the SDK client or your terminal does not
+stop it. Unused held credit is released once shutdown and final usage are confirmed.
+Stopping keeps your uploaded files and
+completed results; the next operation reconstructs the worker. Set a spending cap
+for each workspace in the [dashboard](https://isagoge.in/dashboard).
+
+## Concepts
+
+| Term | Meaning |
+| --- | --- |
+| Environment | A Lean release with Mathlib, prebuilt on LeanWarp, such as `lean-4.26-mathlib`. |
+| Workspace | Your project's files on LeanWarp. One per project; creating it starts no compute. |
+| Worker | The machine that runs Lean for a workspace. It starts on demand and stays warm. |
+| Operation | One request, such as a check or a verification, and its result. |
+| Revision | A numbered version of the workspace's files. Each result names the one it checked. |
+| Receipt | The part of a verification result that records exactly what was checked. |
+
+## Documentation
+
+| Start here | Reference |
+| --- | --- |
+| [Verify your first proof](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/getting-started.md) | [Commands](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#commands) |
+| [Set up an agent with the CLI or MCP](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md) | [Results and exit codes](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#results) |
+| [Use the Python library](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#python) | [Recover an interrupted request](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#recovery) |
+| [Call the HTTP API directly](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/http-api.md) | [Credentials, credit and limits](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#credentials-credit-and-limits) |
+
+The agent instructions ship with the package: `leanwarp skill` prints the
+workflow and `leanwarp skill --reference` the full reference. Run
+`leanwarp --help` or `leanwarp COMMAND --help` for arguments.

leanwarp-0.2.3/README.md

@@ -0,0 +1,178 @@
+<h1><img src="https://raw.githubusercontent.com/Isagoge-Labs/LeanWarp-SDK/main/docs/assets/leanwarp-banner.svg" alt="LeanWarp" width="960"></h1>
+
+LeanWarp checks and verifies Lean 4 proofs on hosted workers that stay warm
+between edits. This SDK is how you and your agents use it: the `leanwarp`
+command, an MCP server and a Python library.
+
+**[Get started](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/getting-started.md)** · [Agent setup](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md) ·
+[Reference](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md) ·
+[HTTP API](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/http-api.md) · [Website](https://isagoge.in/leanwarp)
+
+## What it does
+
+| Operation | What you get | CLI |
+| --- | --- | --- |
+| Check | Lean's errors and warnings for a file; `--draft` reuses Lean's work on the unchanged part while you edit. | `leanwarp check` |
+| Inspect | The goals and local context at a position in a proof. | `leanwarp inspect` |
+| Try tactics | Several tactics from the same captured goal: which close it, which leave goals, which fail. The file is not edited. | `leanwarp try-tactics` |
+| Verify | Whether a declaration proves exactly the statement you give, checked by Lean's kernel. | `leanwarp verify` |
+| Holes | Every `sorry` and `?_` in a file, with its position, and the goals of the first 16. | `leanwarp holes` |
+| Suggest | A tactic that closes a hole, accepted only if nothing else changes and the proof gains no unproved lemma or extra axiom. `apply` writes it into the file. | `leanwarp suggest`, `leanwarp apply` |
+| Sorry to lemma | The proof of each theorem that still has a `sorry` moved into a new named lemma the theorem then uses; the lemma keeps its `sorry`. `apply` writes it. | `leanwarp sorry2lemma` |
+| Declarations | The declarations a file adds, with their types and dependencies. | `leanwarp declarations` |
+| Check files | Up to 64 files checked in one operation. | `leanwarp check-files` |
+
+The [reference](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#commands)
+lists every command and option; `leanwarp skill --reference` prints it.
+
+### Coming soon
+
+These are planned and not available yet:
+
+- **Proof simplification**: replace a proof with a shorter one that still checks.
+- **`have` extraction**: lift named `have` blocks into top-level lemmas.
+- **Batch repair**: fill several holes in one operation.
+
+## Install in two steps
+
+**1. Install.** In a terminal, with [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```sh
+uv tool install leanwarp && leanwarp setup
+```
+
+This installs the `leanwarp` command and its MCP server from
+[PyPI](https://pypi.org/project/leanwarp/). `leanwarp setup` adds the LeanWarp
+skill and MCP server to Claude Code, Codex and Cursor where they are installed,
+and the skill to `~/.agents/skills`. It runs on Linux, macOS and WSL. You don't
+need Lean installed: LeanWarp runs Lean and Mathlib for you.
+
+Or paste this into your agent:
+
+> Install LeanWarp: run `uv tool install leanwarp && leanwarp setup`, then ask me
+> to sign in.
+
+Already have LeanWarp 0.2 from GitHub? Its `leanwarp-sdk` tool owns the
+`leanwarp` command, so replace it instead:
+
+```sh
+uv tool uninstall leanwarp-sdk && uv tool install leanwarp && leanwarp setup
+```
+
+**2. Sign in**, in your own terminal:
+
+```sh
+leanwarp auth login
+```
+
+It opens the dashboard to create an API key; paste the key at the hidden prompt.
+Never paste it into an agent conversation. Then restart your agent.
+
+When a new release is out, results include `update_available`; run
+`leanwarp update` to upgrade and refresh the installed skills.
+
+## Quick start
+
+From your Lean project or one of the [examples](https://github.com/Isagoge-Labs/LeanWarp-SDK/tree/main/examples):
+
+```sh
+leanwarp doctor              # which environment this project runs on
+leanwarp connect             # create the project's workspace
+leanwarp check LeanWarpExample.lean
+```
+
+If a command returns `success: null` (exit `3`), run `leanwarp wait` until it
+finishes before submitting another operation. Then verify:
+
+```sh
+leanwarp verify LeanWarpExample.lean \
+  --declaration add_zero_example --target '∀ n : Nat, n + 0 = n'
+```
+
+Wait for that operation to finish too, then run `leanwarp stop` when you are done.
+
+Every command prints one JSON object. Results start with `success`: `true` when
+the check passed or the proof was verified, `false` when it did not, and `null`
+while the work is still running, in which case run `leanwarp wait`. The exit code
+says the same thing: `0` passed, `1` did not pass, `2` the command failed, `3`
+still running.
+
+## Use with an agent
+
+Give your agent the project directory and this instruction:
+
+> Run `leanwarp skill` and follow it. Use LeanWarp to check this Lean project
+> and verify proofs against their intended statements. Reuse the workspace
+> while you edit, and run `leanwarp stop` when you are done.
+
+For MCP clients, add the server `leanwarp --project /absolute/path/to/project mcp`,
+or `uvx leanwarp --project /absolute/path/to/project mcp`
+without installing. It uses the same key and project state as the CLI. See [agent setup](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md).
+Keep API keys out of prompts, source files and tool arguments.
+
+## Your project and its environment
+
+LeanWarp uploads only your `.lean` files. Lean, Mathlib and every other
+dependency come from an **environment**: a Lean release with Mathlib, already
+built on LeanWarp's workers. Run `leanwarp environments` to list them.
+`leanwarp files` lists what would upload; patterns in `.gitignore` and
+`.leanwarpignore` leave files out.
+
+`leanwarp connect` picks the environment for you:
+
+- If your project's `lean-toolchain` and `lake-manifest.json` match an
+  environment, it uses that one, so results agree with your local build.
+- If your project has neither file, as with a folder of `.lean` files, it uses
+  the only served environment, or the newest served stable Lean release when there are several.
+- If they match no environment, it stops and lists the ones available. Run
+  `leanwarp connect --environment NAME` to check your files there anyway; they
+  then compile against that environment's Lean and Mathlib.
+
+To start a new project, copy one of the [examples](https://github.com/Isagoge-Labs/LeanWarp-SDK/tree/main/examples), which match the
+environments LeanWarp serves.
+
+## Billing
+
+You pay from prepaid credit, billed by the second while a worker runs. Run
+`leanwarp resources` to see the published worker's starting minute price, whether
+charges depend on usage, startup credit hold and idle timeout. LeanWarp selects
+the worker. Use `leanwarp connect --max-spend 2` to create a workspace with a $2
+cap, or edit an existing cap in the dashboard. Reconnecting without a cap keeps
+the saved cap.
+
+When the worker uses usage billing, CPU and RAM charges increase independently
+above their reserved baselines. The starting rate is a paid minimum while the
+worker runs, including idle time. Bursting depends on available host capacity.
+Otherwise, the listed minute rate applies for the time the worker runs. Existing
+workspaces keep their saved billing terms.
+
+A worker starts with your first operation and stays warm between calls. Run
+`leanwarp stop` when finished; closing the SDK client or your terminal does not
+stop it. Unused held credit is released once shutdown and final usage are confirmed.
+Stopping keeps your uploaded files and
+completed results; the next operation reconstructs the worker. Set a spending cap
+for each workspace in the [dashboard](https://isagoge.in/dashboard).
+
+## Concepts
+
+| Term | Meaning |
+| --- | --- |
+| Environment | A Lean release with Mathlib, prebuilt on LeanWarp, such as `lean-4.26-mathlib`. |
+| Workspace | Your project's files on LeanWarp. One per project; creating it starts no compute. |
+| Worker | The machine that runs Lean for a workspace. It starts on demand and stays warm. |
+| Operation | One request, such as a check or a verification, and its result. |
+| Revision | A numbered version of the workspace's files. Each result names the one it checked. |
+| Receipt | The part of a verification result that records exactly what was checked. |
+
+## Documentation
+
+| Start here | Reference |
+| --- | --- |
+| [Verify your first proof](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/getting-started.md) | [Commands](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#commands) |
+| [Set up an agent with the CLI or MCP](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/agents.md) | [Results and exit codes](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#results) |
+| [Use the Python library](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#python) | [Recover an interrupted request](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#recovery) |
+| [Call the HTTP API directly](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/docs/http-api.md) | [Credentials, credit and limits](https://github.com/Isagoge-Labs/LeanWarp-SDK/blob/main/src/leanwarp_cloud/skills/leanwarp/references/usage.md#credentials-credit-and-limits) |
+
+The agent instructions ship with the package: `leanwarp skill` prints the
+workflow and `leanwarp skill --reference` the full reference. Run
+`leanwarp --help` or `leanwarp COMMAND --help` for arguments.

leanwarp-0.2.3/docs/README.md

@@ -0,0 +1,16 @@
+# LeanWarp documentation
+
+- [Getting started](getting-started.md): sign in, choose a project and verify a proof.
+- [Use with an agent](agents.md): the agent instruction, skill and MCP setup.
+- [Commands](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#commands) and
+  [environments](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#environments).
+- [Results and exit codes](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#results):
+  what `success` means and where Lean's messages are.
+- [Python](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#python): use the library.
+- [Recovery](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#recovery): lost
+  responses, timeouts and conflicting edits.
+- [Credentials, credit and limits](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#credentials-credit-and-limits).
+- [HTTP API](http-api.md): for building your own client.
+
+The reference ships with the SDK: `leanwarp skill --reference` prints it without a
+key. Run `leanwarp --help` or `leanwarp COMMAND --help` for arguments.

leanwarp-0.2.3/docs/agents.md

@@ -0,0 +1,97 @@
+# Use LeanWarp with an agent
+
+An agent uses LeanWarp through the `leanwarp` command or its MCP server. Both
+share the same key and the same project state in `.leanwarp/`, so you can switch
+between them. [Install and sign in](getting-started.md) first, then choose the Lean
+project the agent may work in.
+
+## Set up your agents
+
+```sh
+leanwarp setup
+```
+
+This installs the LeanWarp skill for Claude Code (`~/.claude/skills`), Codex
+(`~/.codex/skills`) and other agents (`~/.agents/skills`), and adds the MCP
+server to Claude Code (`claude mcp add`), Codex (`~/.codex/config.toml`) and
+Cursor (`~/.cursor/mcp.json`). Only agents whose configuration folder exists are
+set up; `--agent NAME` sets up one anyway, and `--no-mcp` installs skills only.
+An existing `leanwarp` MCP entry is never replaced. Run `leanwarp auth login`
+yourself, then restart the agent. `leanwarp update` upgrades the command and
+refreshes the installed skills.
+
+## The instruction
+
+Give the agent the project directory and this instruction:
+
+> Run `leanwarp skill` and follow it. Use LeanWarp to check this Lean project
+> and verify proofs against their intended statements. Reuse the workspace
+> while you edit, and run `leanwarp stop` when you are done.
+
+`leanwarp skill` prints the workflow: connecting, checking, reading results,
+verifying against a fixed statement, recovering from lost responses and stopping
+the worker. It also asks the agent to report confirmed problems with LeanWarp
+itself through `leanwarp feedback`, naming the operation instead of quoting your
+source, and to tell you when it does. `leanwarp skill --reference` prints the full reference. Neither needs
+a key or starts compute.
+
+Sign in yourself with `leanwarp auth login`, or inject `LEANWARP_API_KEY` into the
+agent's environment. Never put the key in the instruction.
+
+## Agents with shell access
+
+The CLI is built for agents: every command prints one JSON object, results start
+with `success` (`true`, `false`, or `null` while running), and exit codes separate
+"did not pass" (`1`) from "could not run" (`2`) and "still running" (`3`).
+
+`leanwarp setup` installs the instructions as a skill agents discover
+automatically. For another agent, point its skill installer at the
+[skill directory](../src/leanwarp_cloud/skills/leanwarp), including `references/`.
+
+## MCP
+
+Add this server to your MCP client, with the absolute path of your project:
+
+```json
+{
+  "mcpServers": {
+    "leanwarp": {
+      "command": "leanwarp",
+      "args": ["--project", "/absolute/path/to/lean-project", "mcp"]
+    }
+  }
+}
+```
+
+Use the absolute path of `leanwarp` if the client can't find it on its `PATH`.
+To run the server without installing the command, use
+[uv](https://docs.astral.sh/uv/getting-started/installation/) to fetch it from PyPI:
+
+```json
+{
+  "mcpServers": {
+    "leanwarp": {
+      "command": "uvx",
+      "args": ["leanwarp", "--project", "/absolute/path/to/lean-project", "mcp"]
+    }
+  }
+}
+```
+
+The server starts even before you sign in, so the agent can read its guides; tools
+that call LeanWarp then explain how to sign in.
+
+If the user specifies a workspace budget, pass it to `connect` as
+`max_spend_microusd` ($1 = 1,000,000). Reconnecting without that argument keeps
+the existing cap; a supplied different cap is rejected. Existing caps can be
+changed in the dashboard.
+
+The agent should read the resources `leanwarp://guide` and `leanwarp://reference`
+first. The tools mirror the CLI commands: setup (`doctor`, `files`,
+`environments`, `connect`), proof operations (`check`, `inspect`, `try_tactics`,
+`verify_target`, `holes`, `suggest`, `sorry2lemma`, `extract_decls`,
+`check_files`, and `apply` to write a result into its file), operation control
+(`wait`, `status`, `cancel`, `stop`, `recover`), and workspace and account
+management. The [MCP reference](../src/leanwarp_cloud/skills/leanwarp/references/usage.md#mcp)
+lists the tools and their arguments. Operation tools wait up to 20 seconds for
+their result by default (`wait_seconds`, at most 40).

leanwarp-0.2.3/docs/assets/leanwarp-banner.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="960" height="232" viewBox="0 0 960 232" role="img" aria-labelledby="title desc">
+  <title id="title">LeanWarp</title>
+  <desc id="desc">Lean proofs, checked on warm workers</desc>
+  <rect width="960" height="232" rx="12" fill="#080f14"/>
+  <text x="480" y="112" text-anchor="middle" fill="#f1f6fa" font-family="ui-sans-serif,system-ui,sans-serif" font-size="52" font-weight="650" letter-spacing="-1.5">LeanWarp</text>
+  <text x="480" y="150" text-anchor="middle" fill="#b0c3cf" font-family="ui-sans-serif,system-ui,sans-serif" font-size="20">Lean proofs, checked on warm workers</text>
+</svg>