cli-forge-readme

A writing guide for README.md files, the project documents that explain what software does and how to use it.

In plain words
What is it for?
Creating, improving, auditing, or rewriting READMEs and documenting software projects, libraries, command-line tools, or infrastructure.
Why use it?
It helps turn incomplete or unclear project documentation into concise instructions without making up commands or results.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/destynova2/cli-code-skills/cli-forge-readme
Any agent
npx skills add Destynova2/cli-code-skills --skill cli-forge-readme
Clone the repo
git clone --depth 1 https://github.com/Destynova2/cli-code-skills

Made for: Claude Code, Codex.

Per session 163 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,762 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00163 $0.01762
Opus 5 $0.00081 $0.00881
Sonnet 5 $0.00033 $0.00352
Haiku 4.5 $0.00016 $0.00176

Measured 2d ago against content hash 1cda6e3e34e4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

cli-forge-readme scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

cli-forge-readme/SKILL.md · 138 lines

How it starts

The opening of the file, as written. The whole thing — 138 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Optimization: This skill uses on-demand loading. Heavy content lives in references/ and is loaded only when needed.

Language rule: Skill instructions are written in English. When generating user-facing output, detect the project's primary language (from README, comments, docs, commit messages) and produce the README in that language. If the project is bilingual, ask the user which language to use before proceeding.

Diacritics rule: When the chosen output language uses diacritics (French, Spanish, Portuguese, etc.), render them correctly — including on capitals (É, À, Ç, Ô…). Never strip accents to ASCII: write "sécurité" not "securite", "Rôle" not "Role". ASCII-flattened French is a defect, not a style.

Writing style: Favor clarity — short sentences, one idea per sentence, plain words. A metaphor only when it clarifies. Keep one consistent register (impersonal/infinitive for operational docs). Separate narrative prose, meant to make the reader understand, from telegraphic content (tables, commands, checklists) which stays terse for action.

No fabricated output: Never invent command output, console captures, API responses, metrics, or logs. When real output is needed, emit a clearly-marked placeholder (🚧 "replace with a real capture"), never plausible-but-fake text presented as real.

README Generator — Production First

Generate professional README.md files where results come first, plumbing comes second.

Gotchas — read ../gotchas.md before producing output to avoid known mistakes.

Philosophy

A README is a landing page, not a technical manual.

  • 90% of visitors want to know: what, why, how to start
  • 10% want to contribute or understand internals
  • Structure for the 90%, don't punish them with the 10%

Tone rule: Friendly on the surface, technical in depth.

  • Tier 1–2: plain language, no jargon, a junior dev or a PM can understand
  • Tier 3: full technical depth, assume the reader codes

Workflow

Step 1 — Detect project context

Read the full file on GitHub · 138 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 138 lines · 163 tokens per session scan A 1cda6e3e34e4

Subscribe to this mod's changes

cli-forge-readme is a skill published in the GitHub repository Destynova2/cli-code-skills (5 stars, last pushed 10d ago), licensed MIT. It adds 163 tokens to every session and 1,762 once invoked, about $0.0008 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.