Skip to content

Commit 91fe27a

Browse files
authored
Merge pull request #54 from JRS1986/docs/setup-tool-example-clarity
Clarify setup tool example and dedupe compatibility matrix
2 parents 3bde392 + 718f532 commit 91fe27a

1 file changed

Lines changed: 24 additions & 12 deletions

File tree

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,20 @@ ignored template and fill it on your machine:
105105
coding-scaffold credentials --target . --format env
106106
```
107107

108-
You can also validate or install the coding tool directly:
108+
You can also validate or install a coding tool directly. The default behavior validates that the
109+
tool is on `PATH` and configures the scaffold for it; add `--install` to install a missing tool
110+
without a second prompt (useful for prepared dev containers):
109111

110112
```bash
113+
# Validate + configure (works for any tool):
111114
coding-scaffold setup tool --tool opencode
112-
coding-scaffold setup tool --tool opencode --install
115+
coding-scaffold setup tool --tool claude-code
116+
coding-scaffold setup tool --tool codex
113117
coding-scaffold setup tool --tool hermes
114118
coding-scaffold setup tool --tool pi
119+
120+
# Same command, but install if missing:
121+
coding-scaffold setup tool --tool opencode --install
115122
```
116123

117124
Optional add-ons use the same pattern:
@@ -331,16 +338,21 @@ coding-scaffold setup tool --tool pi
331338
coding-scaffold tools adapt --target ~/dev/my-project --tool pi
332339
```
333340

334-
### Compatibility Matrix
335-
336-
| Tool | Generated by CodingScaffold | Native strengths | Routing stance | Support level |
337-
| --- | --- | --- | --- | --- |
338-
| OpenCode | `opencode.json`, `.opencode/agents/`, `.opencode/commands/` | providers, local models, agents, commands, permissions | recommendation, static profiles, optional gateway routing | deep/default |
339-
| Claude Code | `CLAUDE.md`, `.claude/settings.json`, commands, reviewer agent | project settings, permissions, slash commands, MCP, subagents | guidance and native profile choice | native config |
340-
| Codex | `AGENTS.md`, `.codex/config.toml`, `.codex/skills/` | layered instructions, approval modes, local CLI workflow | guidance and native model choice | native config |
341-
| OpenClaude | `.coding-scaffold/OPENCLAUDE.md` | OpenAI-compatible profiles, MCP, slash commands | guidance and manual profile choice | lightweight |
342-
| Hermes | `.coding-scaffold/HERMES.md` | memory, skills, MCP, messaging, backend choices | guidance and tool-native setup | lightweight |
343-
| Pi | `.coding-scaffold/PI.md` | project instructions, sessions, slash commands, extensions | guidance and tool-native setup | lightweight |
341+
### Support Depth At A Glance
342+
343+
| Tool | Support depth |
344+
| --- | --- |
345+
| OpenCode | deep (full config, agents, commands, RouteLLM-ready) |
346+
| Claude Code | native config (`CLAUDE.md`, `.claude/`, reviewer agent) |
347+
| Codex | native config (`AGENTS.md`, `.codex/`, skills) |
348+
| OpenClaude | guidance (`OPENCLAUDE.md`) |
349+
| Hermes | guidance (`HERMES.md`) |
350+
| Pi | guidance (`PI.md`) |
351+
352+
For the full capability-by-capability breakdown (install support, permissions, MCP, local models,
353+
cloud providers, static profiles, runtime routing, etc.) see the
354+
[compatibility matrix in Tool Adapters](docs/wiki/Tool-Adapters.md#compatibility-matrix) — that's
355+
the single source of truth; this table is a scannable summary.
344356

345357
## Knowledge Base
346358

0 commit comments

Comments
 (0)