xonecas.io
64875
Mc

mini-coder / commit 1759b1a

docs: update README to match current codebase

- Fix tool names: write→create, edit→replace
- Update default model to zen/claude-sonnet-4-6
- List all supported providers (zen, anthropic, openai, google, ollama)
- Add missing slash commands: /undo, /new
- Add post-tool hooks feature (was entirely missing)
- Fix hook path: .agents/ → .agents/hooks/
- Note MAX_SUBAGENT_DEPTH=3 limit
- Add CLI flags section (-c, -r, -l, -m)
- Fix tools/ structure: create, replace instead of write, edit
- Note hashline, diffs, hooks, snapshots in tools/
- Add Biome to tech stack

xonecas2026-02-21 1759b1ae3b611aebfc7883d4c46f72010d6aaac1 parent 389da5a

1 file changed

README.md+28−14
@@ -19,7 +19,7 @@ $ mc
1919 │ │
2020 │ > _ │
2121 │ │
22-│ [zen/claude-sonnet-4] [~/src/my-project] [main] ... │
22+│ [zen/claude-sonnet-4-6] [~/src/my-project] [main] ...│
2323 └───────────────────────────────────────────────────────┘
2424 ```
2525
@@ -34,8 +34,8 @@ I come equipped with a tight, reliable set of tools:
3434 | 🔍 `glob` | Find files by pattern across your project |
3535 | 🧲 `grep` | Search file contents with regex |
3636 | 📖 `read` | Read files (with line-range support) |
37-| 📝 `write` | Create a new file or fully overwrite an existing file |
38-| ✏️ `edit` | Replace or delete lines using hashline anchors |
37+| 📝 `create` | Create a new file or fully overwrite an existing file |
38+| ✏️ `replace` | Replace or delete lines using hashline anchors |
3939 | ➕ `insert` | Insert lines before/after an anchor without replacing |
4040 | 🐚 `shell` | Run shell commands and see their output |
4141 | 🤖 `subagent` | Spawn a focused mini-me for parallel subtasks |
@@ -46,10 +46,11 @@ I can also connect to **MCP servers** (like Exa for web search), giving you supe
4646
4747 ## ⚡ Key Features
4848
49-- **Multi-provider, zero-config** — set `OPENCODE_API_KEY` and I'll auto-discover providers. Ollama running locally? I'll find that too.
50-- **Session memory** — conversations are saved in a local SQLite database. Resume where you left off.
51-- **Shell integration** — prefix with `!` to run shell commands inline. Use `@` to reference files in your prompt.
52-- **Slash commands** — `/model` to switch models, `/plan` for read-only thinking mode, `/review` for a code review, `/mcp` to manage MCP servers.
49+- **Multi-provider** — set `OPENCODE_API_KEY` for Zen, `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `GOOGLE_API_KEY`, or just run Ollama locally. I auto-discover whatever's available.
50+- **Session memory** — conversations are saved in a local SQLite database. Resume where you left off with `-c` or pick a specific session with `-r <id>`.
51+- **Shell integration** — prefix with `!` to run shell commands inline. Use `@` to reference files in your prompt (with Tab completion).
52+- **Slash commands** — `/model` to switch models, `/plan` for read-only thinking mode, `/review` for a code review, `/undo` to roll back a turn, `/new` for a clean session, `/mcp` to manage MCP servers.
53+- **Post-tool hooks** — drop an executable at `.agents/hooks/post-<tool>` and I'll run it after every matching tool call.
5354 - **Beautiful, minimal output** — diffs for edits, formatted trees for file searches, a live status bar with model, git branch, and token counts.
5455 - **16 ANSI colors only** — my output inherits *your* terminal theme. Dark mode, light mode, Solarized, Gruvbox — I fit right in.
5556
@@ -59,9 +60,9 @@ I can also connect to **MCP servers** (like Exa for web search), giving you supe
5960
6061 - **I eat my own dog food.** I was built *by* a mini-coder agent. It's agents all the way down. 🐢
6162 - **I'm tiny but mighty.** The whole runtime is [Bun.js](https://bun.com) — fast startup, native TypeScript, and a built-in SQLite driver.
62-- **I respect existing conventions.** Skill files live in `.agents/`, context in `AGENTS.md` or `CLAUDE.md` — I follow the ecosystem instead of inventing new standards.
63+- **I respect existing conventions.** Hook scripts live in `.agents/hooks/`, context in `AGENTS.md` or `CLAUDE.md` — I follow the ecosystem instead of inventing new standards.
6364 - **I spin while I think.** ⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ (It's the little things.)
64-- **I can clone myself.** The `subagent` tool lets me spin up parallel instances of myself to tackle independent subtasks simultaneously. Divide and conquer!
65+- **I can clone myself.** The `subagent` tool lets me spin up parallel instances of myself to tackle independent subtasks simultaneously. Divide and conquer! (Up to 3 levels deep.)
6566
6667 ---
6768
@@ -71,8 +72,10 @@ I can also connect to **MCP servers** (like Exa for web search), giving you supe
7172 # Install globally
7273 bun install -g .
7374
74-# Set your provider key
75-export OPENCODE_API_KEY=your-key-here
75+# Set your provider key (pick one — or run Ollama locally)
76+export OPENCODE_API_KEY=your-zen-key # recommended
77+export ANTHROPIC_API_KEY=your-key # or direct Anthropic
78+export OPENAI_API_KEY=your-key # or direct OpenAI
7679
7780 # Launch!
7881 mc
@@ -84,17 +87,27 @@ Or run directly for a quick task:
8487 mc "Refactor the auth module to use async/await"
8588 ```
8689
90+Useful flags:
91+
92+```bash
93+mc -c # continue last session
94+mc -r <id> # resume a specific session
95+mc -l # list recent sessions
96+mc -m zen/claude-sonnet-4-6 # pick a model
97+```
98+
8799 ---
88100
89101 ## 🗂️ Project Structure
90102
91103 ```
92104 src/
93- index.ts # Entry point
105+ index.ts # Entry point + CLI arg parsing
94106 agent/ # Main REPL loop + tool registry
95- cli/ # Input, output, slash commands
107+ cli/ # Input, output, slash commands, markdown rendering
96108 llm-api/ # Provider factory + streaming turn logic
97- tools/ # glob, grep, read, write, edit, insert, shell, subagent
109+ tools/ # glob, grep, read, create, replace, insert, shell, subagent
110+ # + hashline anchors, diffs, hooks, snapshots
98111 mcp/ # MCP server connections
99112 session/ # SQLite-backed session & history management
100113 ```
@@ -107,6 +120,7 @@ src/
107120 - **LLM routing:** [AI SDK](https://ai-sdk.dev) — multi-provider with streaming
108121 - **Colors:** [yoctocolors](https://github.com/sindresorhus/yoctocolors) — tiny and terminal-theme-aware
109122 - **Schema validation:** [Zod](https://zod.dev)
123+- **Linting/formatting:** [Biome](https://biomejs.dev)
110124 - **Storage:** `bun:sqlite` — zero-dependency local sessions
111125
112126 ---