auto-readme-lite

🚀 Features

Static Analysis

Parses JS/TS files to detect exported functions, classes, interfaces, and CLI commands.

CLI Command Extraction

Finds commands from commander and yargs for instant CLI docs.

Script Detection

Lists all package.json scripts for easy reference.

Content Safe

Only updates auto-generated sections, preserving your custom README content.

Instant & Offline

No AI, no cloud, no waiting. Works 100% offline and is blazing fast.

Markdown Perfection

Generates clean, professional Markdown with code blocks, headers, and formatting.

⚡ Quick Start

Quick Install & Run

Run directly with npx (no installation needed)

npx auto-readme-lite

Global Installation

Or install globally for repeated use

npm install -g auto-readme-lite
auto-readme-lite

📋 Usage

Command Options

Available command line options

Usage: auto-readme-lite [options]

Options:
  --dry-run     Preview README output without writing
  --watch       Watch mode (auto-update on changes)
  --sections    Comma-separated sections to include (api,cli,scripts,git)
  --dir         Target project directory
  --help        Show help

Example Usage

Basic usage examples

# Generate README for current directory
npx auto-readme-lite

# Preview without writing
npx auto-readme-lite --dry-run

# Watch mode for auto-updates
npx auto-readme-lite --watch

# Specific sections only
npx auto-readme-lite --sections api,cli,scripts --dir ./my-project

📝 Example Output

API Reference

`startDripSystem`

Type: Function

File: drip-booster.js

CLI Commands

add <a> <b> - Add two numbers

Available Scripts

start - node index.js
test - jest
build - tsc

🧪 Try It Live

Test auto-readme-lite with sample code below. Choose a template or write your own!

📝 Input Code

📄 Generated README

Generated README sections will appear here...

🔍 How It Works

🔍

Scans

Your project for .js and .ts files (excluding node_modules, dist, etc.)

⚙️

Parses

Exports, CLI commands, and scripts using ts-morph and Babel

📝

Updates

Only the auto-generated sections in your README.md

💾

Preserves

All your custom content

🔒

Works Offline

Never sends code to the cloud