DocForge

DocForge is a Node.js CLI tool that automatically generates professional README.md files and technical documentation for any project.

Features

• Scans your project for metadata (package.json, structure, etc.)
• Uses OpenAI (placeholder) to summarize and improve descriptions
• Generates a complete README.md with install, usage, contributing, and license sections
• Creates a docs/overview.md with deeper technical explanations
• Supports customization via docforge.config.json

Installation

npm install -g docforge

Or use directly with npx:

npx docforge init

Usage

Run inside your project directory:

npx docforge init

This will generate or update:

• README.md
• docs/overview.md
• docforge.config.json (for customization)

Configuration

Edit docforge.config.json to customize project metadata and regenerate docs.

Development

• Written in modular TypeScript
• Error handling and comments for easy extension
• To build: npm run build
• To test locally: node dist/index.js init or npx docforge init

Publishing

To publish to npm:

1. Update version in package.json
2. Run npm run build
3. Run npm publish

License

MIT