ReadmeForge

AI-powered README generator that analyzes your codebase and creates beautiful documentation — no API keys required!

npm version npm downloads License: MIT
$ npx readme-forge
🔍

Smart Analysis

Automatically detects your project type and extracts metadata from config files

📝

Beautiful Output

Generates well-structured markdown with badges, table of contents, and proper formatting

🌐

Multi-Language

Supports Node.js, Python, Go, and Rust projects out of the box

🔒

Offline First

Works without API keys or internet — your code never leaves your machine

Zero Config

Just run the command and you're done — no setup or configuration needed

🎯

Zero Dependencies

Pure Node.js implementation with nothing to break or update

See It In Action

$ cd my-express-app
$ readme-forge
🔨 readme-forge - Analyzing your project...
✅ Detected: node project
📦 Name: my-express-app
📝 Description: A REST API server
✨ Generated: README.md
87 lines, 2.1KB

Supported Languages

📦

Node.js

package.json

🐍

Python

pyproject.toml, setup.py

🦫

Go

go.mod

🦀

Rust

Cargo.toml

CLI Options

-h, --help

Show help message and available options

-v, --version

Display the current version number

-f, --force

Overwrite existing README.md without prompting

-o, --output

Specify custom output file path (default: README.md)

Ready to Generate?

Stop spending hours writing documentation. Let ReadmeForge do it in seconds.