scaffold-cli-help
Skill0 starsChanged 3 months agoMITView on GitHub
Define or update root CLI help for @finografic CLI projects using HelpConfig in src/cli.help.ts and renderHelp from core/render-help. Use when adding commands, changing help layout, or aligning help with the normalized pattern.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- finografic/ai-skillsword for word, first seen Aug 23, 2026
Other versions1 project uses a version of this.
Word for word · 1
- finografic/ai-skills★ 0100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository15 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- assets/copilot-instructions.mdCopilot instructions
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/agents-entry.mdcCursor rule
- .cursor/rules/git-operations.mdcCursor rule
- apply-design-mdSkill
- generate-design-mdSkill
- maintain-agentsSkill
- scaffold-core-moduleSkill
- apply-design-mdSkill
- generate-design-mdSkill
- maintain-agentsSkill
- scaffold-cli-helpSkill
- scaffold-core-moduleSkill
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 1 is distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
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
- Very specific: line 22
Keep this skill procedural.
- Very specific: line 40
Do not import help types from src/types/ or utils/.
- Very specific: line 55
Wire
src/cli.ts: import renderHelp from core/render-help and cliHelp from ./cli.help.js (use .js extension if the project uses … - Very specific: line 63
Add a row to commands.list (keep descriptions one line).
- Distinctive: line 64
Add Examples entries where users will copy-paste real invocations.
- Very specific: line 65
Update any command-specific help files (src/help/*.help.ts) if this repo splits per-command help — root skill covers root HelpConfig only.
- Very specific: line 70
Do not duplicate renderHelp logic in application code.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Scaffold / maintain CLI help (cli.help.ts)
This skill applies the typed root help pattern used across @finografic CLI tools (genx, gli, and scaffolds from genx).
Read first (repo — canonical for this repository)
.agents/instructions/project/cli-help-patterns.instructions.md— rules, file locations,HelpConfigshape, examples/footer conventions.
Deeper spec (canonical — in this repo)
docs/spec/CLI_CORE.md— fullcore/render-helpAPI (HelpConfig,renderHelp, section shapes), export table, and examples.
Optional context: A temporary bulk-task folder in a monorepo (e.g. ___REFACTORING___) may hold REPORT_CLI_NORMALIZATION.md with migration history. That path is not canonical; use it when you have it for background, not as the spec.
Keep this skill procedural; link to docs/spec/CLI_CORE.md for authoritative types and tables.
Prerequisites
src/core/render-help/exists (shared module; do not rewrite the renderer unless intentionally changingcore/across all CLI repos).tsconfig.jsonincludes"core/*": ["./src/core/*"](or equivalent).- You know the CLI binary name (e.g.
genx) and the commands to list.
Procedure
- Open or create
src/cli.help.tsat the repository root ofsrc/(never nested undercommands/for root help). Import types from the barrel only:
import type { HelpConfig } from 'core/render-help';Do not import help types from
src/types/orutils/.Export a single named config
cliHelp(not default export):export const cliHelp: HelpConfig = { main: { bin: '…', args: '<command> [options]' }, // commands, examples, footer — see instruction file };- Follow section conventions (details in the instruction file):
- examples:
label= human description,description= exact command line. - footer:
labelmay use<placeholder>tokens;descriptionoptional dim line.
- examples:
- Wire
src/cli.ts: importrenderHelpfromcore/render-helpandcliHelpfrom./cli.help.js(use.jsextension if the project usesverbatimModuleSyntax). CallrenderHelp(cliHelp)only from the CLI entry / help branch — not insidecli.help.ts. - Optional shared defaults: genx uses
defaultHelpOptionsfromconfig/help.configforminWidth/ alignment — follow existing project pattern if present. - Verify:
pnpm typecheckand run the binary with--helpor no args to confirm layout.
When adding a new command
- Add a row to
commands.list(keep descriptions one line). - Add Examples entries where users will copy-paste real invocations.
- Update any command-specific help files (
src/help/*.help.ts) if this repo splits per-command help — root skill covers rootHelpConfigonly.
Design constraints
- Root help stays declarative data (
HelpConfig); rendering is centralized incore/render-help. - Do not duplicate
renderHelplogic in application code.
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
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.

