xonecas.io
79113
Ma

mini-coding-agent / commit 7d97781

chore: README updates

xonecas2026-10-08 7d97781be3f23a80de34f9a91cb915898c76faf6 parent 2523000

1 file changed

README.md+23−4
@@ -53,6 +53,19 @@ the config lives. Interactive mode requires a TTY.
5353 | `Ctrl+D` | exit on an empty draft |
5454 | `Tab` | complete command or path |
5555
56+While a turn is paused (`Esc`), submitting a message steers the running turn.
57+
58+## Tools
59+
60+The model sees only the tools listed in `tools`; a call to any other name is an
61+error.
62+
63+| Tool | Behavior |
64+|---|---|
65+| `read` | returns a file's text; `offset` (1-based) and `range` give a line window; text is cut at 100k characters; binary files are refused; `png`/`jpg`/`webp` are returned as an image only when the model accepts image input |
66+| `edit` | replaces `oldText`, which must occur exactly once; an empty `oldText` creates a new file and fails if it exists; prints a unified diff |
67+| `bash` | runs `bash -c` in the cwd with a 120s default `timeout`; output keeps the first 10k and last 6k bytes; a before/after snapshot of the cwd reports changed files as diffs |
68+
5669 ## Configure
5770
5871 The config is one JSON object. It is read from
@@ -73,6 +86,8 @@ A full example:
7386 "discoverAgentFiles": true,
7487 "skillsDirs": ["/home/me/.agents/skills"],
7588 "tools": ["edit", "read", "bash"],
89+ "snapshotIgnoreDirs": [".git"],
90+ "snapshotUsesGitignore": true,
7691 "customProviders": [
7792 {
7893 "id": "local",
@@ -108,9 +123,11 @@ Keys:
108123 | `systemPrompt` | `""` | prepended to the system prompt |
109124 | `sessionsDir` | `$XDG_STATE_HOME/mini-coding-agent/sessions`, else `$HOME/.local/state/mini-coding-agent/sessions`, else `sessions` | where JSONL session logs go |
110125 | `discoverAgentFiles` | `true` | load `AGENTS.md`/`CLAUDE.md` from `$HOME/.agents` and the cwd |
111-| `skillsDirs` | `[]` | directories holding `<name>/SKILL.md` skills |
126+| `skillsDirs` | `[]` | directories holding `<name>/SKILL.md` skills; each `SKILL.md` needs a `name` in its frontmatter (optional `description`) |
112127 | `tools` | `["edit", "read", "bash"]` | which tools the model sees |
113128 | `customProviders` | `[]` | in-tree provider definitions |
129+| `snapshotIgnoreDirs` | `[]` | directory names skipped when the `bash` tool snapshots the cwd for diffs |
130+| `snapshotUsesGitignore` | `true` | also skip directories named in `.gitignore` when snapshotting |
114131
115132 Unknown keys are rejected. `provider` and `model` must both be set to make a
116133 request; a custom provider must list the model in its `models`.
@@ -149,6 +166,8 @@ fails at request time.
149166
150167 ## Sessions
151168
152-Each session is a JSONL directory under `sessionsDir`. Every message and every
153-model request is appended and fsynced. The log is write-only; a write failure
154-stops the turn.
169+Each session is a directory under `sessionsDir` named
170+`<timestamp>-<title>-<id>` with a `session.jsonl` inside it. The title is
171+slugified from the first user message. A header line opens the log; every
172+message and every model request is then appended and fsynced. The log is
173+write-only; a write failure stops the turn.