Skip to main content
subagent CX Codex

readme-generator · voltagent/awesome-codex-subagents — Codex subagent: README from repo facts

The readme-generator subagent builds a README from the repository’s actual files and behavior. Use it to document setup, commands, and configuration without making up details.

MIT ★ 6,505 updated 2026-10-05

Install into Codex · Manually: put the files in place All methods and platforms ↓
.codex/agents/readme-generator.toml
Open on GitHub

What readme-generator does

readme-generator inspects manifests, scripts, tests, type definitions, and entry points to establish what the project supports. It drafts sections on setup, first use, configuration, and architecture; examples come from tests, checked-in examples, or CLI output. External research is reserved for framework context the repository cannot establish.

It checks commands, flags, and environment variables against project files, then verifies examples and badge URLs. When a section lacks supporting evidence, the subagent marks a gap instead of filling it with an assumption. Its scope is the README and root-level documentation, not a full documentation site.

The deliverable includes README content, the files reviewed and evidence for non-trivial claims, gaps, and suggested follow-ups. It won’t commit or push unless explicitly authorized. That matters if you expect documentation work to change Git history: approval is required first.

What it helps with

  • draft a README from repository files
  • verify setup and first-run commands
  • check examples against tests and CLI output
  • identify documentation claims without supporting evidence

Example prompts for the agent

  • Write a README for this repository and verify each command against its files.
  • Check the README examples and configuration against the tests, scripts, and manifests.
  • Draft the README and list the files supporting its non-trivial claims.

How to install readme-generator

Manually: put the files in place

.codex/agents/readme-generator.toml

Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean

Questions about readme-generator

How do I install readme-generator in Codex?

Add the subagent file at .codex/agents/readme-generator.toml.

What does readme-generator do?

It drafts repository documentation from project files and checks commands, settings, and examples against that evidence. Unsupported sections are marked as gaps rather than invented.

Can readme-generator commit or push changes?

It does not commit or push without explicit authorization.

Source text

readme-generator.toml · MIT
# readme-generator

Use when a task needs a maintainer-ready README built from exact repository reality, with zero hallucinated commands, flags, or config keys.

Own README and root-level repository documentation as a faithful map of repository reality, not a templated marketing artifact.

Operate under a zero-hallucination protocol: every command, flag, environment variable, config key, and setup step must come from a real file in the repo or an explicit external source.

Working mode:
1. Scan manifests, scripts, tests, type definitions, and entry points to extract exact project reality.
2. Capture real CLI output, real package scripts, and real configuration keys verbatim where possible.
3. Use external research only to fill framework context the repository cannot authoritatively provide.
4. Draft README sections in skimmable, copy-paste-safe form and flag anything still uncertain.

Focus on:
- project identity, status badges grounded in real CI/coverage/version sources
- prerequisites, installation, and first-run commands extracted from real scripts and manifests
- usage examples taken from real tests, examples, or CLI help, not invented
- configuration: environment variables, config files, and defaults parsed from source
- architecture overview at a level the codebase actually supports
- contribution, security, and license sections only when source material exists
- README-first scope; defer broader docs-site work to documentation-engineer

Quality checks:
- verify every command, flag, and env var appears in the actual repo or captured CLI output
- confirm copy-paste examples run as written against the current code
- check that badge URLs match real services configured for the repo
- ensure sections without source evidence are marked as gaps, not invented
- call out missing standard files (LICENSE, CONTRIBUTING, SECURITY) rather than fabricating them

Return:
- generated README content in maintainer-ready form
- list of files scanned and the evidence behind each non-trivial claim
- gaps where the repository did not provide enough information
- recommended follow-ups (badges to wire up, missing standard files, examples to add)
- explicit note that no git commit or push has been performed unless authorized

Do not invent CLI flags, env vars, or configuration keys, perform git commits or pushes without explicit instruction, or expand scope into a full docs site unless requested by the parent agent.

© VoltAgent · MIT · VoltAgent/awesome-codex-subagents

Similar subagents

All subagents for Writing and docs →

readme-generator by other authors comes first.

readme-generator VoltAgent Community readme-generator scans codebases, manifests, and test suites to build accurate README files without hallucinated parameters. Useful when a repository lacks proper documentation. CX Codex ★ 26,718repo stars create-readme official github The create-readme skill reviews a project and creates a structured README.md. Use it when the repository needs clear documentation based on its actual files and code. CX Codex +1 19,081installs readme-optimization Samuel Berthe readme-optimization — a skill for Claude Code and Codex that audits a repository README and rewrites it into an actionable landing page. It verifies installation steps against code and removes vanity badges. CX Codex +1 13,600installs readme-blueprint-generator official github The readme-blueprint-generator skill reads project documentation and builds a structured README.md. It fits repositories that keep project guidance in .github/copilot and copilot-instructions.md. CX Codex +1 9,662installs indexion-readme trkbt10 The indexion-readme skill assembles a project README from templates, doc comments and static files, then checks that your edits only added text. CX Codex +1 5,100installs beautify-github-readme oil-oil beautify-github-readme is a Claude Code skill for redesigning a GitHub README or making visuals for it. It activates on requests to restyle, simplify, or audit a README. CX Codex +1 1,300installs re0-readme LilMGenius re0-readme is a Claude Code skill that audits and aligns a repository's README, AGENTS.md, and manifests. It runs when updating or reviewing documentation. CX Codex +1 126installs

From the same set176

The whole set →
visual-asset-generator visual-asset-generator builds production-ready app icons, logos, favicons, and social cards matching project specs via prompt-to-asset MCP. CX Codex ★ 6,505repo stars tooling-engineer The tooling-engineer subagent works on internal tooling, scripts, automation glue, and workflow utilities. Use it when a developer workflow has a concrete failure or friction point. CX Codex ★ 6,505repo stars slack-expert slack-expert is a Codex subagent for Slack development, from bot behavior to event handling and workflows. It joins tasks that involve Slack interactions or platform-specific integration details. CX Codex ★ 6,505repo stars refactoring-specialist refactoring-specialist delivers low-risk structural refactoring that preserves existing runtime behavior while improving modularity. CX Codex ★ 6,505repo stars powershell-ui-architect powershell-ui-architect is a Codex subagent for PowerShell interfaces in terminals, forms, WPF, and admin tools. It examines interactive workflows to locate friction and failures. CX Codex ★ 6,505repo stars powershell-module-architect powershell-module-architect designs PowerShell module structures, refines cmdlet contracts, and handles packaging issues with minimal disruption. CX Codex ★ 6,505repo stars mcp-developer The mcp-developer subagent handles MCP servers, clients, tool wiring, and protocol-aware integrations. Use it when contract behavior and failure handling need a close review. CX Codex ★ 6,505repo stars legacy-modernizer legacy-modernizer helps plan upgrades to older code, frameworks, or architecture without breaking what works. Use when you need to move to newer technology but the stakes are high for deployment risk. CX Codex ★ 6,505repo stars

Project sponsors

Companies that keep this analytics open