mindweave 2.5.1 → 3.0.1

package/README.md

@@ -1,145 +1,81 @@
-<h1 align="center">Mindweave (mwcode)</h1>
+<h1 align="center">Mindweave</h1>
 
 <p align="center">
-  A fast, model-adaptive, terminal-native AI coding agent.<br>
+  A coding agent for your terminal.<br>
   You bring your own key. It runs on your machine. Nothing goes anywhere else.
 </p>
 
 <p align="center">
   <a href="LICENSE">Apache 2.0</a> &nbsp;•&nbsp;
-  <a href="https://x.com/mindweavecli">X</a> &nbsp;•&nbsp;
-  <a href="https://mindweavedev.netlify.app/">Website</a>
+  <a href="https://mindweavedev.netlify.app/">Website</a> &nbsp;•&nbsp;
+  <a href="https://github.com/mindweave-cli/mwcode">Desktop app</a> &nbsp;•&nbsp;
+  <a href="https://x.com/mindweavecli">X</a>
 </p>
 
 ---
 
-## What it is
+Mindweave works inside your repository: it reads, searches, edits, runs commands and
+checks its own work. There is no backend and no account. Your code and your key only
+ever go to the model provider you picked.
 
-Mindweave is a coding agent that lives in your terminal and works inside your repository:
-reading, searching, editing, running commands, and checking its own work.
+Prompts are kept thin on purpose, so the context goes on your code rather than on
+scaffolding.
 
-It runs entirely on your machine. There is no backend, no telemetry and no account. Your
-code and your API key never reach a Mindweave server, because there isn't one.
-
-It is built lean on purpose. Most of a coding agent's context budget goes on scaffolding
-the model never needed. Mindweave keeps prompts thin and leaves the room for the model to
-reason about your code.
-
-
-## Mindweave 1
-
-Mindweave 1 is out, tagged `mindweave-1`. It is on npm, and the website is up. Install
-with the steps below.
-
-What landed in it is in the [changelog](CHANGELOG.md): fourteen model providers, a
-rebuilt terminal interface, reworked prompt caching and token accounting, project notes
-the agent maintains across sessions, and a long list of things that were quietly wrong.
+Prefer a window to a terminal? [mwcode](https://github.com/mindweave-cli/mwcode) is the
+desktop app, built on the same engine, for Windows, macOS and Linux.
 
 ## Install
 
-Requires **Windows** and **Node.js 20+**. macOS and Linux are not supported yet, and the
-reason is written down in [KNOWN-ISSUES.md](KNOWN-ISSUES.md) rather than glossed over.
+Needs **Node.js 24+**. The npm package is supported on **Windows**; on macOS and Linux,
+use the desktop app for now ([why](KNOWN-ISSUES.md)).
 
 ```bash
 npm install -g mindweave
-```
-
-Then, in any project:
-
-```bash
 cd your-project
-mindweave          # or mw, for short
+mindweave          # or mw
 ```
 
-To build from source instead — for development, or to run an unreleased change:
+It asks for an API key on first launch and keeps it in `~/.mindweave/.env`.
+
+From source:
 
 ```bash
-git clone https://github.com/mindweave-cli/Mindweave
-cd Mindweave
+git clone https://github.com/mindweave-cli/mindweave
+cd mindweave
 npm install
 npm run build
-npm link          # makes the `mindweave` command available globally
+npm link
 ```
 
-It asks for an API key on first launch and saves it to `~/.mindweave/.env`, so every
-project afterwards just works. `mindweave --help` covers the launch flags; everything
-else is configured inside a session.
-
-
-## What it can do
-
-Short version, one line each. The depth is in the linked pages.
-
-- **15 providers, 60 models, one key** — DeepSeek, Anthropic, OpenAI, Gemini, xAI,
-  Mistral, Groq, Cerebras, Qwen, Kimi, GLM, Meta, MiniMax, Tencent, plus every
-  tool-capable model on OpenRouter. Only the driver you
-  use is loaded. Switch with `/provider` and `/model`; remembered per project.
-  [PROVIDERS.md](src/drivers/PROVIDERS.md)
-- **Real tools** — read and edit files, multi-file edits, ripgrep search, a shell with
-  background jobs, and sub-agents. Every edit comes back with the language server's own
-  errors for that file. Read-before-edit is enforced, and `/undo` is a real net.
-- **Deterministic code intelligence** — a background lane indexes your repo with
-  tree-sitter and language servers, costing no tokens, so the agent understands the
-  codebase, not just the open file.
-- **Session memory** — automatic compaction plus a running state summary that survives
-  it, and the agent can read its own earlier sessions in a project.
-- **Project notes** — MINDWEAVE.md is loaded every session and maintained by the agent;
-  `@./path` imports split it, a per-folder one applies only there, and `~/.mindweave/`
-  holds machine-wide notes. `/init` writes the first one.
-- **MCP servers** — connect external tool servers with `/mcp add` or in plain words;
-  their output is untrusted by default. [docs/MCP.md](docs/MCP.md)
-- **Images and web search** — drop a screenshot or write `@shot.png`; ask about a recent
-  release and it looks it up, through your own provider.
-- **Seeing your app** — it can capture one named window (never the whole screen, and it
-  asks first) to tell an app that started from one that works.
-- **Per-project governor** — standing rules, reusable skills, and forbidden paths or
-  commands the agent must respect.
-
-## Using it
-
-| Command | What it does |
-| --- | --- |
-| `/help` | Lists every command |
-| `/init` | Writes MINDWEAVE.md, the project notes loaded every session |
-| `/provider` · `/model` · `/think` | Who answers, which model, how hard it reasons |
-| `/clear` · `/continue` | Start fresh, or resume an earlier session |
-| `/undo` | Reverts what the last turn changed |
-| `/update` | Installs the newest version and reopens on this conversation |
-| `/mcp` | Manages connected MCP servers |
-| `/feedback` | Sends the maintainer a message, no account needed |
-| `shift-tab` | Cycles interaction modes |
-
-Type while it works and your message queues; press up to take it back and edit it.
-
-## Read more
-
-| | |
-| --- | --- |
-| [CHANGELOG.md](CHANGELOG.md) | What changed, and what each fix actually was |
-| [KNOWN-ISSUES.md](KNOWN-ISSUES.md) | What is broken or unfinished, written down rather than carried quietly |
-| [PHILOSOPHY.md](PHILOSOPHY.md) | How the project is run and what gets into the core. Short, and the honest version |
-| [BOUNDARY.md](BOUNDARY.md) | What belongs in the core versus a driver |
-| [CONTRIBUTING.md](CONTRIBUTING.md) | Mechanics, and what is most useful to report |
-| [SECURITY.md](SECURITY.md) | Reporting a vulnerability |
-| [docs/MCP.md](docs/MCP.md) | Connecting and trusting MCP servers |
-
-## Contributing
-
-Contributions are welcome, especially **model drivers**: Ollama is a stub waiting for
-someone, and a driver is a smaller job than people expect, owning one provider's wire
-format and nothing about how the agent behaves.
-
-Small fixes and reproduced bugs with a failing test can go straight to a pull request.
-For anything larger, start a Discussion first. AI-assisted contributions are fine; the
-one rule is that you understand and have tested what you are submitting.
-
-Bug reports are genuinely the most useful thing you can send. Mindweave is developed by
-running it on real projects and fixing what breaks, and nearly everything in the
-changelog started as a failure someone watched happen. [What to include, and what is
-especially worth reporting.](CONTRIBUTING.md#reporting-a-bug)
-
-Questions are welcome at zallinimann@gmail.com
+## What it does
+
+- **16 providers, 62 models** — DeepSeek, Anthropic, OpenAI, Gemini, xAI, Mistral, Groq, Cerebras,
+  Qwen, Kimi, GLM, Meta, MiniMax, Tencent, OpenRouter, and local models through Ollama
+  with no key at all. [PROVIDERS.md](src/drivers/PROVIDERS.md)
+- **Real tools** — file reads and edits, search, a shell with background jobs,
+  sub-agents, web search, and a tool that tests your app by using it.
+- **Code intelligence** — tree-sitter and language servers index the repo in the
+  background, at no token cost, and every edit comes back with that file's errors.
+- **Goals that run on their own** — `/marathon` takes a goal and keeps going until it is
+  verified done, blocked, or out of budget.
+- **Memory** — project notes in MINDWEAVE.md, compaction that keeps what matters, and
+  earlier sessions it can look back at.
+- **Safety nets** — `/undo`, `/rewind`, approval modes, and per-project rules for paths
+  and commands it must not touch.
+- **MCP servers** — connect external tools with `/mcp`. [docs/MCP.md](docs/MCP.md)
+
+`/help` lists every command. `shift+tab` switches modes. Type while it works and your
+message queues.
+
+## More
+
+[CHANGELOG](CHANGELOG.md) · [Known issues](KNOWN-ISSUES.md) ·
+[Philosophy](PHILOSOPHY.md) · [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md)
+
+Contributions are welcome, model drivers especially. Bug reports are the most useful
+thing you can send ([what to include](CONTRIBUTING.md#reporting-a-bug)). Questions:
+zallinimann@gmail.com
 
 ## License
 
-[Apache License 2.0](LICENSE).
+[Apache License 2.0](LICENSE)