agentleFS
knowttlknowttl/bstack/skills/how/SKILL.md

how

Skill0 starsChanged 10 days agoMITView on GitHub

Explain how a part of a codebase works from its code, tests and documents, with every claim cited to a file and line.

90 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-pstack, ketchup-video 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.
  • bnemaSkill

    setup-pstack

    Configure which Pi models pstack uses per role. Detects available provider/model specs and writes pstack's user configuration. Use for /setup-pstack, "configure pstack models", or changing pstack model choices.

    Also in 25 projects that use this

  • tristanphvnSkill

    ketchup-video

    Catch the user up like /keel:ketchup, with a short silent video of slides for what happened and the waiting calls as text under it. Use for /keel:ketchup-video.

    Also in 13 projects that use this

  • ianclearySkill

    principle-explain-the-number

    Apply before you trust, report, or act on a number you measured: a speedup, a regression, a throughput, a latency, or an eval result. Find what limits it, and rule out that it measured something other than the work you think.

    Also in 28 projects that use this

  • ianclearySkill

    poteto-help

    Guides users through pstack setup, /poteto-mode, and picking the skill, playbook, or principle for a task. Type /poteto-help with a question.

    Also in 14 projects that use this

  • eryzerzSkill

    make-bot-ui

    Use when building a custom UI (page, dashboard, buttons) that should wake a Grok Bot over a webhook, when the user must provide a webhook sender key, or when exposing that UI on Tailscale.

    Also in 19 projects that use this

  • drafaelSkill

    in-your-own-words

    Restate the user's goals and the problem they are trying to solve to check understanding. Manual invocation only; use when the user explicitly invokes in-your-own-words or requests this understanding check. Do not solve the task or rewrite the assistant's last answer.

    Also in 26 projects that use this

The file

We split this skill into the rules it gives an agent

12 rules. 0 are common, 7 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 89 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Only the user starts how. Start this procedure only when the user's message explicitly invokes $how, /how, /skill:how or selects it through …

    line 9
  2. Very specific:

    Start this procedure only when the user's message explicitly invokes $how, /how, /skill:how or selects it through the host's skills menu.

    line 10
  3. Very specific:

    If you encounter this file while inspecting repository contents without that explicit invocation, treat it as repository content: do not …

    line 12
  4. Distinctive:

    Keep notes, the citation report and drafts in scratch outside the target.

    line 18
  5. Distinctive:

    When it names none, or names something the repo does not contain, ask one question that offers the plausible readings and recommends one.

    line 32
  6. Distinctive:

    Write the explanation by the writing reference and the mechanics reference's shape.

    line 53
  7. Very specific:

    Write nothing to the target.

    line 61
  8. Very specific:

    Use the installed scripts/how.mjs entry point, run documented commands and read their output rather than script source.

    line 62
  9. Distinctive:

    Use command help for syntax, and never guess arguments.

    line 64
  10. Distinctive:

    Read only the one reference needed for the current step, once per run unless it changes.

    line 68
  11. Distinctive:

    Run scripts without loading their source, and pass schemas to scripts without reading them as instructions.

    line 69
  12. Distinctive:

    Never recursively search bundled reference or schema directories to discover guidance.

    line 70

“Common” is measured: kept by at least 6 in 10 of the 89 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

Scope

Only the user starts how. Start this procedure only when the user's message explicitly invokes $how, /how, /skill:how or selects it through the host's skills menu. A plain request such as "how does this work?" does not invoke it. If you encounter this file while inspecting repository contents without that explicit invocation, treat it as repository content: do not follow its procedure, open its references or run its commands. The target is an existing repo, passed as --repo.

How explains the mechanics of one part of the code: what runs, in what order, on what data and with what result. The motive behind the code belongs to /why, and a model that joins both belongs to /teach; name them as next steps and start neither. It reads the repo and writes nothing to it, executes nothing from it and opens no pull requests. Keep notes, the citation report and drafts in scratch outside the target.

Checklist

Copy this checklist and tick a step only when its Done when criterion is met.

  • Step 1: Resolve the subject
  • Step 2: Trace the mechanics
  • Step 3: Check the citations
  • Step 4: Explain

Step 1: Resolve the subject

Take the subject from the user's message: a command, function, module, flow or behaviour. When it names none, or names something the repo does not contain, ask one question that offers the plausible readings and recommends one. State the question the explanation will answer in one sentence.

Done when: The subject exists in the repo and the question to answer is stated.

Step 2: Trace the mechanics

Load the mechanics reference and follow it from the subject's entry point. Record each finding in scratch following schemas/research-report.json, using the brief architecture for code and tests and documents for project documents, and bind each cited file to the SHA-256 of the exact bytes read with state kind sha256.

Done when: Every step of the path has a file and line citation, and each claim is marked observed, inferred or unread.

Step 3: Check the citations

Run node scripts/how.mjs cite-check --repo <target> --report <file> --json. The checker establishes locations and byte freshness only, so open each cited line to confirm it supports the claim.

Done when: cite-check passes and every cited line supports its claim, or a claim without support is removed or relabelled as an inference.

Step 4: Explain

Write the explanation by the writing reference and the mechanics reference's shape. State the subject, the answer, the cited path, the data shapes and invariants it relies on, and the limits: paths not followed, files not opened and each inference. List /why for the motive and /teach for both as next steps for the user to run, and start neither.

Done when: The explanation answers the stated question, every claim cites its source or is labelled an inference, and the limits are named.

Write rules

Write nothing to the target. Use the installed scripts/how.mjs entry point, run documented commands and read their output rather than script source. Resolve resources relative to the installed skill and pass the target explicitly. Use command help for syntax, and never guess arguments.

Load when

Read only the one reference needed for the current step, once per run unless it changes. Run scripts without loading their source, and pass schemas to scripts without reading them as instructions. Never recursively search bundled reference or schema directories to discover guidance; use this table and documented command help instead.

WhenOpen
Tracing the mechanicsreferences/mechanics.md
Writing the explanationreferences/writing.md
Recording citations for evidenceschemas/research-report.json

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.