agentleFS
Sign inStart free
codewhale-hqcodewhale-hq/codewhale-plugin-marketplace/skills/help/SKILL.md

help

Skill5 starsChanged 17 days agoMITView on GitHub

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.

76 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-stories, story-done and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • lilangMaxSkill

    create-stories

    Break a single epic into implementable story files. Reads the epic, its GDD, governing ADRs, and control manifest. Each story embeds its GDD requirement TR-ID, ADR guidance, acceptance criteria, story type, and test evidence path. Run after /create-epics for each epic.

    Also in 9 projects that use this

  • lilangMaxSkill

    story-done

    End-of-story completion review. Reads the story file, verifies each acceptance criterion against the implementation, checks for GDD/ADR deviations, prompts code review, updates story status to Complete, and surfaces the next ready story from the sprint.

    Also in 9 projects that use this

  • +10 more from lilangMax

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 57 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not paste a manual, a command list, or a settings table into context.

    line 19
  2. Distinctive:

    Do not answer from memory of another harness.

    line 20
  3. Distinctive:

    Do not guess at flags, config keys, or paths.

    line 21
  4. Very specific:

    When the workspace *is* a Codewhale checkout, docs/ is present on disk and the read tool (path: "docs/...") is the right tool.

    line 42
  5. Distinctive:

    If a surface disagrees with your recollection, the surface wins.

    line 50
  6. Distinctive:

    If nothing local answers it, say so and stop.

    line 51

“Common” is measured: kept by at least 6 in 10 of the 57 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Help

Invocation

Explicit-only. This skill is a router, not a manual. It is deliberately kept out of the ambient model catalogue so it never spends prompt budget, and it never restates documentation that the running build already exposes.

When to use

Load it only when the user explicitly asks how to use Codewhale itself — a command, a setting, a keybinding, or where a feature lives.

Non-goals

  • Do not paste a manual, a command list, or a settings table into context.
  • Do not answer from memory of another harness; Codewhale's surfaces differ.
  • Do not guess at flags, config keys, or paths. Read them, or say you did not.

Routing table

Answer from the surface that owns the fact, in this order:

  1. Slash commands — /help lists the commands this build registers; /help <command> prints that command's usage line. This is the only authoritative command list, because it is generated from the registry.
  2. Skills — /skills opens the manager, /skills inspect prints the discovery mode, searched directories, and source paths. /skill <name> activates one. See docs/SKILLS.md in a Codewhale checkout.
  3. Configuration — /config is the live settings surface. Config file keys are documented in docs/CONFIGURATION.md; provider/model routing in docs/PROVIDERS.md.
  4. Keybindings — docs/KEYBINDINGS.md in a checkout. There is no keybinding slash command; do not invent one.
  5. Environment problems — codewhale-tui doctor reports the resolved config path, provider credential presence (never values), and workspace state. Prefer its output over inference.

Working in a Codewhale checkout

When the workspace is a Codewhale checkout, docs/ is present on disk and the read tool (path: "docs/...") is the right tool. Read the single most relevant file and quote the specific lines. Outside a checkout, docs/ is usually absent — in that case rely on /help, /config, and doctor, and say plainly that the reference docs are not installed locally.

Bounds

  • One surface per question. Do not sweep docs/ looking for context.
  • If a surface disagrees with your recollection, the surface wins.
  • If nothing local answers it, say so and stop; do not invent a flag.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free