agentleFS
ShahriarBijoyShahriarBijoy/show-me-how/skills/init/SKILL.md

init

Skill0 starsChanged 3 months agoMITView on GitHub

Set up show-me-how for this repo: creates show-me-how.md (mascot, font, colors, tone, output folder) and generates one test image.

  • Reads credentials
  • Installs packages

137 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use daily-arxiv, exp-eval 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.
  • LambenthanSkill

    daily-arxiv

    每日从 arXiv 拉取新论文,过滤相关性,auto-ingest 高优先级论文,检测 SOTA 更新

    Also in 5 projects that use this

  • LambenthanSkill

    exp-eval

    实验判决门:Review LLM 独立评判实验结果 → 4 种判决路径 → 自动更新 claims confidence、ideas status、graph edges

    Also in 5 projects that use this

  • skyllwtSkill

    exp-pilot-eval

    Pilot result evaluation — read pilot results, apply success criteria, update idea page (pilot_result, failure_reason if failed), generate PILOT_VERDICT_REPORT. Called by /ideate Phase 5 after /exp-pilot-run.

    Also in 4 projects that use this

  • skyllwtSkill

    exp-pilot-run

    Pilot experiment execution — read Pilot Spec YAML, write pilot code, run experiment(Confirm with the user before operation and require the applicant to conduct manual inspection), return results. Called by /ideate Phase 5. Does NOT modify wiki pages or judge pass/fail.

    Also in 4 projects that use this

  • gaebalaiSkill

    codex-system

    PROACTIVELY consult Codex CLI, your highly capable supporter with exceptional reasoning and task completion abilities. Codex is a trusted expert you should ALWAYS consult BEFORE making decisions on: design choices, implementation approaches, debugging strategies, refactoring plans, or any non-trivial problem. When uncertain, consult Codex. Don't hesitate - Codex provides better analysis. Explicit triggers: "think deeper", "analyze", "second opinion", "consult codex".

    Also in 3 projects that use this

  • +6 more from Lambenthan
  • +1 more from skyllwt

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 125 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    If $PLUGIN/node_modules/sharp is missing, run npm install --silent with cwd $PLUGIN.

    line 37
  2. Very specific:

    If the line starts with backend: codex, backend: gemini-api, backend: openai-api or backend: openrouter, continue to step 4.

    line 39
  3. Very specific:

    not found -> run npm i -g @openai/codex yourself (ask permission first), then re-check.

    line 44
  4. Very specific:

    not logged in -> codex login is interactive and opens a browser, so you cannot run it.

    line 46
  5. Very specific:

    If detect still does not say backend: codex after one round, say so, leave backend: auto in show-me-how.md (codex is picked up whenever it …

    line 47
  6. Distinctive:

    Never ask for, echo, or write the key itself anywhere.

    line 53
  7. Very specific:

    If installDir is null, show the hint line and continue.

    line 56

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

/show-me-how:init

REPO = absolute path of the git root (git rev-parse --show-toplevel). Run every command from there.

PLUGIN = the plugin's install folder: the CLAUDE_PLUGIN_ROOT environment variable if set (Claude Code), otherwise two directories above this SKILL.md (Codex, OpenCode, others).

Questions below: use your harness's question tool when it has one (Claude Code: AskUserQuestion; Codex: request_user_input); otherwise ask in plain text and wait for the reply before continuing.

0. Existing config

Run node "$PLUGIN/scripts/design.mjs" "REPO" and read its file field. Do not look for the file yourself: a repo may have its own unrelated design.md (a product design doc), and that is not ours -- file is null in that case and you proceed as if no config exists. Never read, edit or overwrite a design.md that file does not point at.

  • file is null: continue to step 1.
  • file ends in show-me-how.md: say so and ask one question: overwrite, or edit by hand? If they choose edit, stop. Only proceed on an explicit "overwrite" answer.
  • file ends in design.md (a legacy show-me-how config, recognised by its # show-me-how design first line): say that the config file is now called show-me-how.md and ask the same overwrite-or-edit question. On "overwrite", write REPO/show-me-how.md in step 2 and tell the user the old design.md can be deleted; do not delete it yourself.

1. Ask (one at a time)

  1. Mascot: (a) Use Flow, the default (b) Describe your own (c) I have 1-3 reference images. For (b) ask for 1-2 sentences describing shape, eyes, limbs, expression. For (c) ask for the paths, then still ask for the one-line description.
  2. Font for labels: (a) Caveat, handwritten default (b) a local .ttf/.otf path.
  3. Colors: (a) defaults orange/red/blue (b) three hex values for flow / warn / note.
  4. Tone, 2-3 words (default "deadpan, absurd, clean").
  5. Docs folder (default docs/show-me-how/).

2. Write show-me-how.md

Copy $PLUGIN/templates/show-me-how.md to REPO/show-me-how.md and edit in the answered fields; keep all comments and every field the user did not change.

3. Dependencies and backend

  1. If $PLUGIN/node_modules/sharp is missing, run npm install --silent with cwd $PLUGIN.
  2. node "$PLUGIN/scripts/backend.mjs" detect --cwd "REPO" -> prints backend: .... Show that line to the user verbatim.
  3. If the line starts with backend: codex, backend: gemini-api, backend: openai-api or backend: openrouter, continue to step 4. Otherwise it starts with backend: manual (...); ask one question:

    "Automatic images need one of: (a) the Codex CLI signed in with a paid ChatGPT plan (Plus or higher) -- no per-image cost; (b) a Gemini API key -- about $0.03-0.13 per panel; (c) an OpenAI API key -- about $0.01-0.30 per panel; (d) an OpenRouter key -- one key for Gemini, GPT Image, FLUX, Seedream and more at vendor prices; (e) none / not now -- I write prompt files you paste into ChatGPT or Gemini yourself (manual). Prices are approximate list prices as of 2026-08."

    • (a): fix only what the detect line said is missing, in this order, then rerun detect and show the new line:
      • not found -> run npm i -g @openai/codex yourself (ask permission first), then re-check.
      • too old -> run npm i -g @openai/codex@latest yourself (ask permission first), then re-check.
      • not logged in -> codex login is interactive and opens a browser, so you cannot run it. Tell the user to run it in their terminal (Claude Code: ! codex login; Codex: a second terminal), wait for them to say it is done, then re-check. If detect still does not say backend: codex after one round, say so, leave backend: auto in show-me-how.md (codex is picked up whenever it becomes ready) and continue with manual for the test image.
    • (b): ask one more question, the model: "Nano Banana 2 (gemini-3.1-flash-image, ~$0.07/panel, ~$0.35 per 5-panel doc; best character consistency) / Nano Banana 2 Lite (gemini-3.1-flash-lite-image, ~$0.03/panel, ~$0.17 per doc) / Nano Banana Pro (gemini-3-pro-image, ~$0.13/panel, ~$0.67 per doc)". Write backend: gemini-api and image_model: <id> into ## Output of REPO/show-me-how.md. Then say: get a key at https://aistudio.google.com/apikey and set GEMINI_API_KEY in the environment (the agent must be restarted from a shell where it is exported). Re-run detect. If it now says backend: gemini-api, continue to step 4; otherwise say the key is not visible yet, leave the pin in place, and skip the test image (step 4) -- the next run picks it up.
    • (c): ask one more question, the model and quality: "GPT Image 2 (gpt-image-2; medium ~$0.10/panel, low ~$0.02, high ~$0.30) / GPT Image 1.5 (gpt-image-1.5; same tiers) / GPT Image 1 mini (gpt-image-1-mini; medium ~$0.02/panel, low ~$0.01, high ~$0.05)". Write backend: openai-api, image_model: <id> and image_api_quality: <tier> into ## Output. Then say: get a key at https://platform.openai.com/api-keys and set OPENAI_API_KEY (same restart note). Re-run detect and proceed exactly as in (b).
    • (d): ask one more question, the model: "Nano Banana 2 (google/gemini-3.1-flash-image, ~$0.07/panel, ~$0.35 per 5-panel doc; best character consistency per dollar, recommended) / GPT Image 2 (openai/gpt-image-2, ~$0.10/panel, ~$0.50 per doc; top of the image-edit arena) / Seedream 5.0 Pro (bytedance-seed/seedream-5-0-pro, ~$0.05/panel, ~$0.23 per doc; best price-to-quality) / Nano Banana 2 Lite (google/gemini-3.1-flash-lite-image, ~$0.03/panel, ~$0.17 per doc; budget) / another id from https://openrouter.ai/api/v1/images/models". Write backend: openrouter and image_model: <id> into ## Output. Then say: get a key at https://openrouter.ai/keys and set OPENROUTER_API_KEY (same restart note). Re-run detect and proceed exactly as in (b). Each panel reports the real charge.
    • (e): set backend: manual in ## Output so later runs stop repeating the hint. They can change it back to auto any time.

    Never ask for, echo, or write the key itself anywhere.

  4. Label font: node "$PLUGIN/scripts/font.mjs" check --design-cwd "REPO" -> one JSON line. ok:true -> nothing to do. ok:false means sharp cannot use the font file on this machine (macOS: it resolves fonts through CoreText and ignores font files, so every label would come out in Helvetica). Then:
    • If installDir is non-null, ask one question: "The label font (<font>) has to be installed for your user on this machine, or labels will render in the system font. Copy it into <installDir> now? (a) Yes (b) No, I'll do it myself." On (a) run node "$PLUGIN/scripts/font.mjs" install --design-cwd "REPO" and show its ok result; if still ok:false, show the hint line. On (b) show the hint line and continue.
    • If installDir is null, show the hint line and continue.

4. Test image

<docs> is the docs: folder from the show-me-how.md just written (step 2). OUTDIR = <docs> with any trailing slash removed, plus /_test (no trailing slash, matching illustrate's DIR convention).

Invoke the illustrate skill (skills/illustrate/SKILL.md) from its step 0, with this brief block:

MODE: explain
TOPIC: show-me-how test
SOURCES: (none)
BRIEF: A mascot hands a reader one clear picture instead of three paragraphs.
MAX_IMAGES: 1
OUTDIR: <that value>

Per illustrate step 0.3, OUTDIR is used as DIR instead of the slug-derived path.

5. Report

Print exactly: the show-me-how.md path, the backend line from step 3.2, the test image path (or the pending prompt file, if generation fell back to manual), and these three next commands:

/show-me-how:explain <topic>
/show-me-how:write-doc <path or topic>
/show-me-how:init          (rerun any time to change show-me-how.md)

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.