readme-forge

AI-powered README generator. One command. Professional docs.

Why?

Writing a good README is tedious. readme-forge analyzes your project — package.json, file structure, dependencies, git history — and generates a professional README in seconds using Claude AI.

Install

npm install -g readme-forge

Setup

Set your Anthropic API key:

export ANTHROPIC_API_KEY=sk-ant-...

Get a key at console.anthropic.com

Usage

# Generate README for current project
readme-forge

# Choose template style
readme-forge generate --template minimal
readme-forge generate --template detailed

# Preview without writing
readme-forge generate --dry-run

# Check existing README quality
readme-forge check

# Add badges to README
readme-forge badge

# Generate table of contents
readme-forge toc

Commands

| Command | Description | Needs API Key | |---------|-------------|:---:| | readme-forge generate | Generate README from project analysis | Yes | | readme-forge check | Score your existing README (A+ to F) | No | | readme-forge badge | Auto-detect and add project badges | No | | readme-forge toc | Generate table of contents | No |

Templates

minimal — Title, description, install, usage, license. Nothing more.

standard (default) — Badges, features, install, usage, contributing, license.

detailed — Everything + TOC, tech stack table, project structure, env vars, deployment.

How it works

1. Scans your project: package.json, file structure, dependencies, git info
2. Detects language, framework, tools, CI/CD setup
3. Sends analysis to Claude (your API key, your data)
4. Returns clean Markdown — no fluff, no hallucination

Your code is NOT sent to the API. Only metadata (file names, package names, scripts) is sent.

Privacy

• Your source code stays local. Only project metadata is sent to Anthropic's API.
• Your API key is used directly — we don't proxy or store anything.
• check, badge, and toc commands work 100% offline.

Contributing

See CONTRIBUTING.md

License

MIT — Scuton Technology