| 💾 Saved. d722711 k33g 4h ago | 1 | # mini-me — documentation (English) |
| 2 | |
| 3 | `mm` is a coding agent that runs in your terminal, or inside an editor through the Agent Client Protocol. It talks to a local model server (Docker Model Runner or llama.cpp's `llama-server`) and works with a handful of built-in tools: `bash`, `read_skill`, `read_file`, `write_file`, `edit_file`. |
| 4 | |
| 5 | This documentation is organised along the four [Diátaxis](https://diataxis.fr) quadrants. Pick the one that matches what you need right now. |
| 6 | |
| 7 | ## Tutorials — learn by doing |
| 8 | |
| 9 | - [Your first session with mini-me](tutorials/getting-started.md) |
| 10 | |
| 11 | ## How-to guides — get a task done |
| 12 | |
| 13 | - [Run mini-me on llama.cpp instead of Docker Model Runner](how-to/run-with-llama-cpp.md) |
| 14 | - [Use mini-me from an editor (ACP)](how-to/use-from-an-editor.md) |
| 15 | - [Add a skill](how-to/add-a-skill.md) |
| 16 | - [Keep a long session inside the context window](how-to/manage-the-context-window.md) |
| 17 | - [Start a new session without restarting](how-to/start-a-new-session.md) |
| 18 | - [Point the model at a file with `@path`](how-to/attach-a-file.md) |
| 19 | |
| 20 | ## Reference — look it up |
| 21 | |
| 22 | - [Command line](reference/cli.md) — flags, environment variables, start-up banner |
| 23 | - [Slash commands](reference/slash-commands.md) — `/quit`, `/abort`, `/compact`, `/new`, keyboard shortcuts |
| 24 | - [Configuration file](reference/configuration.md) — every YAML key, its default and its validation rule |
| 25 | - [Built-in tools](reference/tools.md) — `bash`, `read_skill`, `read_file`, `write_file`, `edit_file` |
| 26 | - [Skill file format](reference/skill-format.md) |
| 27 | - [Agent Client Protocol surface](reference/acp.md) |
| 28 | |
| 29 | ## Explanation — understand |
| 30 | |
| 31 | - [Architecture: one loop, two front ends](explanation/architecture.md) |
| 32 | - [Providers: one implementation per protocol](explanation/providers.md) |
| 33 | - [Context compression](explanation/context-compression.md) |
| 34 | - Package diagram (draw.io source): [`docs/diagrams/packages.drawio`](../diagrams/packages.drawio) |
| 35 | |
| 36 | ## Scope |
| 37 | |
| 38 | This documentation covers the `mm` binary and the packages under `internal/`. The `kits/` and `tmp/` directories at the repository root are not part of the project and are not documented here. |