xonecas.io
64875
Mc

mini-coder / commit 176f33a

docs: document headless mode and release docs sync

xonecas2026-04-09 176f33a83ff4d94196194e7c40f7bbd89d954c39 parent ede9997

2 files changed

AGENTS.md+7−0
@@ -53,6 +53,13 @@
5353 - `bun run format`
5454 - `bun run typecheck`
5555 - `bun pm pack --dry-run --ignore-scripts`
56+- Pre-release docs sync:
57+ - audit `README.md` against `spec.md` and the current command/CLI sources (`src/input.ts`, `src/ui/help.ts`, `src/cli.ts`, `src/headless.ts`, `package.json`)
58+ - update `README.md` on `main` first
59+ - update the `gh-pages` branch in a separate `git worktree`
60+ - sync `README.md`, `spec.md`, and `AGENTS.md` into that `gh-pages` worktree so the branch does not keep stale repo docs
61+ - update `gh-pages/index.html` so its install, features, commands, and headless-mode copy matches the repo docs and current behavior
62+ - review the `gh-pages` diff before committing or pushing it
5663 - Release flow:
5764 - if the version needs to change, update only `package.json`
5865 - review the diff with the user before committing
README.md+14−0
@@ -84,6 +84,20 @@ Plugins can add more tools, but the core stays intentionally small.
8484 | `Ctrl+R` | Search global raw input history |
8585 | `Ctrl+C` | Graceful exit |
8686
87+## Headless one-shot mode
88+
89+mini-coder also supports a non-interactive one-shot mode for scripts and benchmark harnesses.
90+
91+```bash
92+$ mc -p "summarize this repo"
93+$ printf '%s\n' 'fix the failing tests' | mc
94+```
95+
96+- Enabled when `-p/--prompt` is provided or when stdin/stdout is not a TTY.
97+- Reuses the same input parsing rules as the interactive UI for plain text, `/skill:name`, and standalone image paths.
98+- Streams newline-delimited JSON events to stdout.
99+- Interactive slash commands such as `/model` and `/help` are not available in headless mode.
100+
87101 ## Docs
88102
89103 - **Docs site:** https://sacenox.github.io/mini-coder/