agentmods.dev

readme_file.create

readme_file.create is a skill for Claude Code from gpsaggese/helpers. It costs 11 tokens per session (512 once invoked), scanned B, original, Apache-2.0.

A workflow for writing or updating documentation for one executable or script. It reads the program's inputs, outputs, options, side effects, and internal structure before producing a README file.

In plain words
What is it for?
Use it to create or refresh a program README with a summary, examples, configuration, outputs, side effects, and software architecture.
Why use it?
It prevents documentation from omitting important command options, generated files, exit codes, or architectural details.

Skill for Claude Code

Written for Claude Code: installed under .claude/. Also seen: model in frontmatter; reads .claude/ paths.

not rated 158repo +1 today B scan 11 tokens original Apache-2.0

Good fit Use it to create or refresh a program README with a summary, examples, configuration, outputs, side effects, and software architecture.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/gpsaggese/helpers/readme_file.create
View source ↗ gpsaggese/helpers
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.

Any agent
npx skills add gpsaggese/helpers --skill readme_file.create
Clone the repo
git clone --depth 1 https://github.com/gpsaggese/helpers

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme_file.create

README.md
[![agentmods](https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.create/github.svg)](https://agentmods.dev/skills/gpsaggese/helpers/readme_file.create)
Your own site
<a href="https://agentmods.dev/skills/gpsaggese/helpers/readme_file.create"><img src="https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.create/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme_file.create

Your own site · 80×15
<a href="https://agentmods.dev/skills/gpsaggese/helpers/readme_file.create"><img src="https://agentmods.dev/badge/skills/gpsaggese/helpers/readme_file.create.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 11 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 512 The whole file, excluding the scripts and references it only reads on demand.
Security scan B 1 finding. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00011 $0.00512
Opus 5.5 $0.00004 $0.00205
Sonnet 5.5 $0.00002 $0.00102
Haiku 4.5 $0.00001 $0.00051

Measured yesterday against content hash 1a3ef20262b7, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade B, and why

readme_file.create scanned grade B with 1 finding 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 yesterday.

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.

Enumerates other installed skillsmediumAgent snooping

Other skills' SKILL.md files reveal prompts, capabilities and secrets that should be invisible to peers.

`<FILE>.README.md` in the same dir - Follow `.claude/skills/readme_file.rules.md` and the template
Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.claude/skills/readme_file.create/SKILL.md · 64 lines

What it actually says

Goal

  • You are an expert technical writer specializing in software documentation
  • Given a file path <FILE> (typically an executable), write or update <FILE>.README.md in the same dir
  • Follow .claude/skills/readme_file.rules.md and the template .claude/templates/readme_file.template.md

Workflow

Read the File

  • Read <FILE> and identify:
    • The entry point and the argument parser (flags, types, defaults)
    • The inputs, outputs, and side effects (files, exit codes, logging)
    • The key functions and the data flow

Check the Existing README

  • If <FILE>.README.md exists, read it and plan the update
  • Otherwise, plan the content from scratch

Write the README

  • Write <FILE>.README.md with these sections from .claude/skills/readme_file.rules.md:
    • Summary
    • Examples
    • Configuration & Inputs
    • Output & Side Effects
    • Software Architecture
  • For Software Architecture, reuse the steps of .claude/skills/readme_file.write_architecture/SKILL.md
  • Right after the title, add how the README was generated: 
    - Generated by `.claude/skills/readme_file.create/SKILL.md`
  • Follow all formatting rules in .claude/skills/readme_file.rules.md:
    • Examples ordered from simple to complex
    • Commands as bullet + fenced block with the > prefix
    • Argument reference as a table

Point to the README from the File

  • Make the docstring of <FILE> point to <FILE>.README.md, e.g., 
    For a description of this file, see the file <FILE>.README.md

Verification

  • <FILE>.README.md exists in the same directory as <FILE>
  • Every required section from .claude/skills/readme_file.rules.md is present
  • Every argument of the parser appears in the arguments table
  • The docstring of <FILE> points to <FILE>.README.md
  • The README says that it was generated by .claude/skills/readme_file.create/SKILL.md
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. yesterday First seen · 64 lines · 11 tokens per session scan B 1a3ef20262b7

Subscribe to this mod's changes

readme_file.create is a skill published in the GitHub repository gpsaggese/helpers (158 stars, last pushed today), licensed Apache-2.0. It adds 11 tokens to every session and 512 once invoked, about $0.0000 per session on Opus 5.5. A static security scan graded it B with 1 finding (enumerates other installed skills). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-11-06.

DocumentsWriting and docs
Related

readme_file.create compared with skills from other repositories

readme_file.create next to 6 skills from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
readme_file.creategpsaggese/helpersSkill158todayApache-2.0B11Claude Code
orbit-notionnexu-io/open-designSkill106ktodayApache-2.0A117Claude Code, Codex
instrument-data-to-allotropeanthropics/knowledge-work-pluginsSkill35ktodayApache-2.0A123Claude Code
apify-youtube-transcript-scrapersickn33/agentic-awesome-skillsSkill49kyesterdayMITA48Claude Code
legal-holdanthropics/claude-for-legalSkill9.9ktodayApache-2.0A68Claude Code
report-to-pdfasgeirtj/system_prompts_leaksSkill71ktodayCC0-1.0A17Claude Code, Codex
artifact-template-minimal-letterheadasgeirtj/system_prompts_leaksSkill71ktodayCC0-1.0A54Claude Code, Codex