mini-coder 0.0.23 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +39 -157
  2. package/dist/mc.js +135 -51
  3. package/docs/mini-coder.1.md +221 -102
  4. package/package.json +3 -2
  5. package/docs/configs.md +0 -118
  6. package/docs/custom-agents.md +0 -69
  7. package/docs/custom-commands.md +0 -141
  8. package/docs/skills.md +0 -83
package/docs/custom-commands.md DELETED
@@ -1,141 +0,0 @@
1
- # Custom Commands
2
-
3
- Custom commands let you define reusable prompts that run as `/command` in the mini-coder REPL.
4
-
5
- mini-coder is shell-first: when a command needs repo inspection or verification, tell it to use shell. When it needs a targeted file edit, tell it to invoke `mc-edit` from shell rather than relying on old local file-edit tools.
6
-
7
- ## Where to put them
8
-
9
- | Location | Scope |
10
- |---|---|
11
- | `.agents/commands/*.md` | Current repo only |
12
- | `~/.agents/commands/*.md` | All projects (global) |
13
- | `.claude/commands/*.md` | Current repo only (Claude-compatible) |
14
- | `~/.claude/commands/*.md` | All projects (global, Claude-compatible) |
15
-
16
- Local commands override global ones with the same name. At the same scope, `.agents` wins over `.claude`.
17
-
18
- ## Create a command
19
-
20
- Create a markdown file. The filename becomes the command name.
21
-
22
- `.agents/commands/standup.md`:
23
-
24
- ```md
25
- ---
26
- description: Summarise what changed since yesterday
27
- model: zen/claude-haiku-4-5
28
- ---
29
-
30
- Run `!`git log --oneline --since=yesterday`` and summarise the changes
31
- as a short standup update. Group by theme, skip merge commits.
32
- ```
33
-
34
- Then in the REPL:
35
-
36
- ```
37
- /standup
38
- ```
39
-
40
- ## Frontmatter fields
41
-
42
- | Field | Required | Description |
43
- |---|---|---|
44
- | `description` | No | Shown in `/help`. Defaults to the command name. |
45
- | `model` | No | Override the active model for this command (only applies when `context: fork`). |
46
- | `context` | No | Set to `fork` to run the command as an isolated subagent; default runs inline. |
47
- | `subtask` | No | Set to `true` to force subagent execution (OpenCode-compatible alias for `context: fork`). |
48
- | `agent` | No | Run the command under a named agent's system prompt (only applies when `context: fork`). |
49
-
50
- ## Arguments
51
-
52
- Use `$ARGUMENTS` for the full argument string, or `$1`, `$2`, … `$9` for individual tokens.
53
-
54
- `.agents/commands/search.md`:
55
-
56
- ```md
57
- ---
58
- description: Search the codebase for a topic
59
- model: zen/claude-haiku-4-5
60
- ---
61
-
62
- Search the codebase for: $ARGUMENTS
63
-
64
- Use shell and skill-loading tools as needed to explore thoroughly. Report all
65
- relevant files, key code snippets with line numbers, and a short summary.
66
- Be exhaustive but concise. No edits.
67
- ```
68
-
69
- ```
70
- /search session management
71
- /search error handling in providers
72
- ```
73
-
74
- Positional tokens:
75
-
76
- ```md
77
- ---
78
- description: Create a new component
79
- ---
80
-
81
- Create a React component named $1 in the $2 directory.
82
- Use TypeScript, include prop types and a default export.
83
- ```
84
-
85
- ```
86
- /component Button src/ui
87
- ```
88
-
89
- ## Shell interpolation
90
-
91
- Use `` !`cmd` `` to inject shell output into the prompt at expansion time.
92
- Commands time out after 10 seconds.
93
-
94
- ```md
95
- ---
96
- description: Review failing tests
97
- ---
98
-
99
- The following tests are currently failing:
100
-
101
- !`bun test 2>&1 | grep "fail\|✗" | head -20`
102
-
103
- Investigate the failures and suggest fixes. Read the relevant source
104
- files before drawing conclusions.
105
- ```
106
-
107
- ```
108
- /fix-tests
109
- ```
110
-
111
- ## Model override
112
-
113
- Specify a model in frontmatter to use a faster or cheaper model for
114
- lightweight tasks regardless of what the session is currently set to.
115
-
116
- ```md
117
- ---
118
- description: Quick symbol search
119
- model: zen/claude-haiku-4-5
120
- ---
121
-
122
- Find all usages of $ARGUMENTS across the codebase using shell.
123
- List each occurrence with file path and line number. No explanations needed.
124
- ```
125
-
126
- Large models for deep analysis, small models for search and lookup.
127
-
128
- ## Precedence
129
-
130
- Custom commands shadow built-ins. The global `/review`
131
- command (auto-created at `~/.agents/commands/review.md` on first run) works
132
- the same way — a local `.agents/commands/review.md` will override it.
133
-
134
- ## Listing commands
135
-
136
- ```
137
- /help
138
- ```
139
-
140
- Custom commands are listed at the bottom under **custom commands**, tagged
141
- with `(local)` or `(global)`.
package/docs/skills.md DELETED
@@ -1,83 +0,0 @@
1
- # Skills
2
-
3
- Skills are reusable instruction files discovered automatically from local and global directories.
4
-
5
- When a skill tells mini-coder how to work with files, prefer shell for inspection/search/verification and `mc-edit` from shell for targeted edits.
6
-
7
- - The model sees **skill metadata only** by default (name, description, source).
8
- - Full `SKILL.md` content is loaded **on demand**:
9
- - when explicitly requested with the runtime skill tools (`listSkills` / `readSkill`), or
10
- - when you reference `@skill-name` in your prompt.
11
-
12
- ## Discovery locations
13
-
14
- Skills live in folders containing `SKILL.md`:
15
-
16
- | Location | Scope |
17
- |---|---|
18
- | `.agents/skills/<name>/SKILL.md` | Local |
19
- | `.claude/skills/<name>/SKILL.md` | Local (Claude-compatible) |
20
- | `~/.agents/skills/<name>/SKILL.md` | Global |
21
- | `~/.claude/skills/<name>/SKILL.md` | Global (Claude-compatible) |
22
-
23
- Local discovery walks up from the current working directory to the git worktree root.
24
-
25
- ## Precedence rules
26
-
27
- If multiple skills share the same `name`, precedence is deterministic:
28
-
29
- 1. Nearest local directory wins over farther ancestor directories.
30
- 2. Any local skill wins over global.
31
- 3. At the same scope/path level, `.agents` wins over `.claude`.
32
-
33
- ## Frontmatter
34
-
35
- `SKILL.md` frontmatter supports:
36
-
37
- - `name` (**required**)
38
- - `description` (**required**)
39
-
40
- `name` constraints:
41
-
42
- - lowercase alphanumeric and hyphen format (`^[a-z0-9]+(?:-[a-z0-9]+)*$`)
43
- - 1–64 characters
44
-
45
- Unknown frontmatter fields are allowed.
46
-
47
- If either `name` or `description` is missing, mini-coder skips the skill and prints a warning.
48
-
49
-
50
- ## Create a skill
51
-
52
- `.agents/skills/conventional-commits/SKILL.md`:
53
-
54
- ```md
55
- ---
56
- name: conventional-commits
57
- description: Conventional commit message format rules
58
- ---
59
-
60
- # Conventional Commits
61
-
62
- Use:
63
- <type>(<scope>): <short summary>
64
- ```
65
-
66
- ## Use a skill explicitly
67
-
68
- ```text
69
- @conventional-commits write a commit message for my staged changes
70
- ```
71
-
72
- `@skill-name` injects the raw skill body wrapped as:
73
-
74
- ```xml
75
- <skill name="conventional-commits">
76
- ...
77
- </skill>
78
- ```
79
-
80
- ## Tab completion and help
81
-
82
- - Type `@` then `Tab` to complete skill names.
83
- - Run `/help` to list discovered skills with `(local)` / `(global)` tags.