返回 CodeWhale
SKILL.md
根目录 / crates / tui / assets / skills / help / SKILL.md
1 ---
2 name: help
3 description: Route a "how do I use Codewhale" question to the installed help, config, and doctor surfaces instead of reciting a manual from memory. Explicit-only.
4 invocation: explicit-only
5 ---
6
7 # Help
8
9 ## Invocation
10 Explicit-only. This skill is a router, not a manual. It is deliberately kept
11 out of the ambient model catalogue so it never spends prompt budget, and it
12 never restates documentation that the running build already exposes.
13
14 ## When to use
15 Load it only when the user explicitly asks how to use Codewhale itself —
16 a command, a setting, a keybinding, or where a feature lives.
17
18 ## Non-goals
19 - Do not paste a manual, a command list, or a settings table into context.
20 - Do not answer from memory of another harness; Codewhale's surfaces differ.
21 - Do not guess at flags, config keys, or paths. Read them, or say you did not.
22
23 ## Routing table
24 Answer from the surface that owns the fact, in this order:
25
26 1. **Slash commands** — `/help` lists the commands this build registers;
27 `/help <command>` prints that command's usage line. This is the only
28 authoritative command list, because it is generated from the registry.
29 2. **Skills** — `/skills` opens the manager, `/skills inspect` prints the
30 discovery mode, searched directories, and source paths. `/skill <name>`
31 activates one. See `docs/SKILLS.md` in a Codewhale checkout.
32 3. **Configuration** — `/config` is the live settings surface. Config file
33 keys are documented in `docs/CONFIGURATION.md`; provider/model routing in
34 `docs/PROVIDERS.md`.
35 4. **Keybindings** — `docs/KEYBINDINGS.md` in a checkout. There is no
36 keybinding slash command; do not invent one.
37 5. **Environment problems** — `codewhale-tui doctor` reports the resolved
38 config path, provider credential presence (never values), and workspace
39 state. Prefer its output over inference.
40
41 ## Working in a Codewhale checkout
42 When the workspace *is* a Codewhale checkout, `docs/` is present on disk and
43 `File` with `action: "read"` is the right tool. Read the single most relevant file and quote
44 the specific lines. Outside a checkout, `docs/` is usually absent — in that
45 case rely on `/help`, `/config`, and `doctor`, and say plainly that the
46 reference docs are not installed locally.
47
48 ## Bounds
49 - One surface per question. Do not sweep `docs/` looking for context.
50 - If a surface disagrees with your recollection, the surface wins.
51 - If nothing local answers it, say so and stop; do not invent a flag.
52
52 lines MARKDOWN