Generate a README from Your Codebase in One Shot
Staring at a blank README? Claude Code can read your project and write one for you in seconds.
Read the project structure and key files, then write a README.md that includes:
- Project overview and purpose
- Tech stack
- Setup and installation instructions
- Usage examples
Match the tone to the existing code comments.
Claude will explore the codebase, read your package.json or composer.json, check any existing docs, and piece together a coherent README. It's especially useful for internal tools and libraries that never got proper documentation.
# Generate docs for a specific module
claude "Read the /src/payments directory and write a PAYMENTS.md
explaining how the payment flow works for a new engineer joining
the team. Assume they know the language but not this codebase."
You can also point it at a specific audience:
Write a README.md aimed at non-technical stakeholders — focus on
what the project does, not how it works. Skip the setup instructions.
Claude adapts well to tone and audience — tell it who's reading and it'll calibrate. Once you have a first draft, ask it to fill in any gaps or expand specific sections.
Your README writes itself — you just need to ask.
Log in to leave a comment.
The /security-review command scans your uncommitted changes for injection vectors, auth gaps, hardcoded secrets, and other common vulnerabilities.
The SessionStart hook fires when any session begins or resumes, making it ideal for loading environment variables and running one-time setup scripts.
Ask Claude to write property-based tests for your functions using fast-check — it identifies the mathematical invariants in your code and generates tests that cover inputs you'd never enumerate by hand.