xonecas.io
64875
Mc

mini-coder / commit db4e871

docs: rewrite README

xonecas2026-04-07 db4e8718133a21b337c7b9db6b3f1e173e7f74b5 parent 218a23b

2 files changed

README.md+101−15
@@ -1,33 +1,119 @@
1-# mini-coder
1+<p align="center">
2+ <img src="assets/icon-2-dark-terminal.svg" alt="mini-coder logo" width="112" />
3+</p>
24
3-A CLI coding agent. Small, fast, focused.
5+<h1 align="center">mini-coder</h1>
46
5-## What is it?
7+<p align="center"><strong>Lightning-fast coding agent for your terminal.</strong></p>
68
7-mini-coder (`mc`) is a terminal-based coding agent that reads your codebase, makes changes, and verifies them — all through natural conversation. It runs in your terminal, connects to your preferred LLM provider, and gets work done.
9+<p align="center">
10+ Small, fast, focused, and just opinionated enough to be useful.
11+</p>
812
9-## Features
13+<p align="center">
14+ <a href="https://www.npmjs.com/package/mini-coder">npm</a>
15+ ·
16+ <a href="https://sacenox.github.io/mini-coder/">gh-pages</a>
17+ ·
18+ <a href="spec.md">spec</a>
19+</p>
1020
11-- **Two core tools**: `shell` and `edit` — inspect, mutate, verify.
12-- **Multi-provider**: Anthropic, OpenAI, Google, and many more via [pi-ai](https://github.com/badlogic/pi-mono/tree/main/packages/ai).
13-- **Rich TUI**: Streamed markdown, scrollable conversation log, status bar — powered by [cel-tui](https://github.com/sacenox/cel-tui).
14-- **Sessions**: Persistent conversation history, fork, undo.
15-- **Community standards**: [AGENTS.md](https://agents.md) and [Agent Skills](https://agentskills.io) support.
16-- **Plugins**: Extend with custom tools, MCP servers, and more.
21+<p align="center">
22+ <picture>
23+ <img src="assets/preview-0-5-0.png" alt="mini-coder terminal screenshot" width="960" style="border-radius: 10px; box-shadow: 0 10px 30px rgba(0,0,0,0.35);" />
24+ </picture>
25+</p>
1726
18-## Install
27+mini-coder (`mc`) is a terminal coding agent that reads your repo, edits files, runs commands, and keeps going until the work is done. The rewrite trims the product down to the essentials: a sharp system prompt, a small tool surface, streamed terminal UX, and strong foundations instead of framework soup.
28+
29+## Why mini-coder?
30+
31+- **Terminal-native** — no browser tab, no web app shell, no waiting around.
32+- **Tiny core tool surface** — `shell` and `edit` do the real work. `readImage` joins when the model supports vision.
33+- **Streams everything** — assistant text, reasoning, tool calls, and tool output show up as they happen.
34+- **Actually remembers things** — sessions are persisted in SQLite with undo, fork, resume, and cumulative usage stats.
35+- **Plays well with the community** — supports [AGENTS.md](https://agents.md), [Agent Skills](https://agentskills.io), and plugins.
36+- **Built on proven parts** — [pi-ai](https://github.com/badlogic/pi-mono/tree/main/packages/ai) for providers and [cel-tui](https://github.com/sacenox/cel-tui) for the TUI.
37+
38+## Install the stable release
39+
40+The published npm release installs a working `mc` binary:
1941
2042 ```bash
21-# coming soon
22-bun install -g mini-coder
43+npm install -g mini-coder
44+mc
2345 ```
2446
25-## Usage
47+If you prefer Bun globally:
2648
2749 ```bash
50+bun add -g mini-coder
2851 mc
2952 ```
3053
54+## Try the rewrite (`0.5.x`)
55+
56+The rewrite is in progress on this repo right now. If you want the new version before it is published, clone the repo and run it directly with Bun:
57+
58+```bash
59+git clone git@github.com:sacenox/mini-coder.git
60+cd mini-coder
61+bun install
62+bun run src/index.ts
63+```
64+
65+Or give yourself a handy alias:
66+
67+```bash
68+alias mc-dev='bun run ~/src/mini-coder/src/index.ts'
69+mc-dev
70+```
71+
72+## What you get
73+
74+- **Coding-agent workflow** — inspect with shell, mutate with edit, verify with shell.
75+- **Multi-provider model support** — Anthropic, OpenAI, Google, OpenRouter, Ollama, Copilot, and more via pi-ai.
76+- **Streaming TUI** — markdown conversation log, tool blocks, animated divider, and a two-line status bar.
77+- **Session persistence** — resume old sessions, `/fork` them, `/undo` turns, and keep working.
78+- **Reasoning + verbosity controls** — toggle thinking visibility and full tool output on demand.
79+- **Prompt context from your repo** — AGENTS.md discovery, skill catalog support, git state in the prompt footer.
80+- **Plugin path** — optional tools, integrations, theme overrides, and prompt suffixes without bloating the core.
81+
82+## Handy commands
83+
84+- `/model` — switch models
85+- `/session` — resume a session
86+- `/new` — start fresh
87+- `/fork` — branch the conversation
88+- `/undo` — remove the last conversational turn
89+- `/reasoning` — toggle thinking visibility
90+- `/verbose` — toggle full tool output
91+- `/login` / `/logout` — manage OAuth providers
92+- `/effort` — set reasoning effort
93+- `/help` — list the whole menu
94+
95+## Status
96+
97+mini-coder has a stable published release on npm today.
98+
99+The rewrite tracked in this repo is the next generation: smaller, faster, more spec-driven, and more focused on being a great coding agent in the terminal. If you want the stable packaged release, install from npm. If you want the shiny new hotness, run `main` from source.
100+
101+## Docs
102+
103+- **Product site:** https://sacenox.github.io/mini-coder/
104+- **Spec:** [`spec.md`](spec.md)
105+- **Repo instructions:** [`AGENTS.md`](AGENTS.md)
106+
107+## Development
108+
109+```bash
110+bun install
111+bun test
112+bun run check
113+bun run format
114+bun run typecheck
115+```
116+
31117 ## License
32118
33119 MIT
package.json+2−2
@@ -18,8 +18,8 @@
1818 "test": "bun test"
1919 },
2020 "dependencies": {
21- "@cel-tui/components": "^0.3.0",
22- "@cel-tui/core": "^0.3.0",
21+ "@cel-tui/components": "^0.4.0",
22+ "@cel-tui/core": "^0.4.0",
2323 "@mariozechner/pi-ai": "^0.65.0",
2424 "diff": "^8.0.4"
2525 },