{"_id":"@cravex1862/readmegen-cli","name":"@cravex1862/readmegen-cli","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@cravex1862/readmegen-cli","version":"1.0.0","description":"AI-powered README generator for any local repository","main":"dist/index.js","bin":{"readmegen":"dist/index.js"},"scripts":{"build":"tsc","test":"vitest run","prepublishOnly":"npm run build && npm test","preversion":"npm test","version":"git add -A","postversion":"git push && git push --tags"},"keywords":["readme","generator","cli","ai","openai","anthropic","gemini","documentation","tui"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/Cravex1862/readmegen.git"},"homepage":"https://github.com/Cravex1862/readmegen#readme","bugs":{"url":"https://github.com/Cravex1862/readmegen/issues"},"engines":{"node":">=18"},"dependencies":{"commander":"^12.0.0","picocolors":"^1.1.1"},"devDependencies":{"@types/node":"^20.11.0","typescript":"^5.3.0","vitest":"^1.2.0"},"gitHead":"58139b39ad0a1a2f8ad10e8da0e60e1190d6df69","types":"./dist/index.d.ts","_id":"@cravex1862/readmegen-cli@1.0.0","_nodeVersion":"24.12.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-iMWHf2wss6qCWFkjcjtfctfg5MyZ2840f6w8Rl4ITBV6toKkBY6xRD+O61FpDwqpRXrfs64itCjI8DsSC9F4nA==","shasum":"b4d6033a0278b5ed8a5702fb36a4d7413a88233f","tarball":"https://registry.npmjs.org/@cravex1862/readmegen-cli/-/readmegen-cli-1.0.0.tgz","fileCount":66,"unpackedSize":117625,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGhFrJKiuAqDxlGMmlI/mCV7qGhfKCY2bNH5D9E5aGCbAiADRp/m+obbg6BFfWt3xnNSfB8lsR8iuQwTzspjZpFrSA=="}]},"_npmUser":{"name":"cravex1862","email":"ashwinchoudhury1310@gmail.com"},"directories":{},"maintainers":[{"name":"cravex1862","email":"ashwinchoudhury1310@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/readmegen-cli_1.0.0_1781009076908_0.9968793259863071"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-09T12:44:36.773Z","1.0.0":"2026-06-09T12:44:37.080Z","modified":"2026-06-09T12:44:37.307Z"},"maintainers":[{"name":"cravex1862","email":"ashwinchoudhury1310@gmail.com"}],"description":"AI-powered README generator for any local repository","homepage":"https://github.com/Cravex1862/readmegen#readme","keywords":["readme","generator","cli","ai","openai","anthropic","gemini","documentation","tui"],"repository":{"type":"git","url":"git+https://github.com/Cravex1862/readmegen.git"},"bugs":{"url":"https://github.com/Cravex1862/readmegen/issues"},"license":"MIT","readme":"# readmegen\n\n![npm version](https://img.shields.io/npm/v/@cravex1862/readmegen-cli) ![license](https://img.shields.io/badge/license-MIT-blue) ![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)\n\nreadmegen is an AI-powered CLI tool that generates comprehensive README.md files for any local repository. It analyzes your project structure, dependencies, and source code to produce documentation in seconds.\n\n```bash\nnpm install -g @cravex1862/readmegen-cli\n```\n\n## Features\n\n- **🤖 Multi-provider AI** — OpenAI, Anthropic, Google Gemini, GitHub Copilot. Auto-detects your API key.\n- **📦 Offline mode** — `--no-ai` generates a full template from config files and source scanning.\n- **📁 Universal parser** — package.json, requirements.txt, Cargo.toml, pyproject.toml, Gemfile.\n- **🔍 Source scanner** — Extracts exports from JS/TS, Python, Rust files.\n- **🌳 File tree** — Auto-generated ASCII tree of your project structure.\n- **🎨 Beautiful TUI** — Colored terminal output with progress spinners and summary box.\n- **🔄 Cross-platform** — Windows, macOS, Linux.\n\n## Usage\n\n```bash\nreadmegen [path] [options]\n```\n\n| Argument | Description |\n|----------|-------------|\n| `path` | Project directory (default: `.`) |\n\n| Option | Description |\n|--------|-------------|\n| `--no-ai` | Skip AI, use templates only |\n| `-o, --output <file>` | Output file (default: `./README.md`) |\n| `--overwrite` | Overwrite existing file |\n| `--provider <name>` | AI provider: `openai`, `anthropic`, `google`, `github-copilot` |\n| `--model <name>` | Model name (provider-specific default) |\n| `-h, --help` | Show help |\n\n### Examples\n\n```bash\n# Generate with auto-detected AI provider\nreadmegen\n\n# Generate for a specific project\nreadmegen ../my-project\n\n# Template-only mode (no API key needed)\nreadmegen --no-ai\n\n# Write to a custom location\nreadmegen -o docs/README.md --overwrite\n\n# Use a specific provider and model\nreadmegen --provider google --model gemini-2.5-flash\n```\n\n## API Keys\n\nSet one of these environment variables — readmegen auto-detects which is available:\n\n| Provider | Variable |\n|----------|----------|\n| Google Gemini | `GOOGLE_API_KEY` |\n| OpenAI | `OPENAI_API_KEY` |\n| Anthropic | `ANTHROPIC_API_KEY` |\n| GitHub Copilot | `GITHUB_TOKEN` |\n\n## What It Generates\n\n```\n┌────────────────────────────────────────────┐\n│  readmegen complete                        │\n│                                            │\n│    ✔ Parse config files                    │\n│    ✔ Scan source files                     │\n│    ✔ Generate file tree                    │\n│    ✔ AI description (Gemini 2.5 Flash)     │\n│    ✔ Write README file                     │\n│                                            │\n│  📄 ./README.md                            │\n│  ⚡ 2.3s                                    │\n│  🤖 google                                 │\n└────────────────────────────────────────────┘\n```\n\nThe output includes: project description, installation, usage, API reference (auto-detected exports), scripts table, file tree, dependencies, troubleshooting, contributing, license.\n\n## Offline Mode\n\nWith `--no-ai`, readmegen works entirely offline by parsing your project's config files and scanning source code for exports. No API key required.\n\n```bash\nreadmegen --no-ai\n```\n\n## Supported Languages\n\n| Language | Config Parsing | Source Scanning |\n|----------|---------------|-----------------|\n| JavaScript / TypeScript | package.json | ✅ Exports |\n| Python | requirements.txt, pyproject.toml | ✅ Functions/classes |\n| Rust | Cargo.toml | ✅ `pub fn`, `pub struct` |\n| Ruby | Gemfile | — |\n\n## Web Demo\n\nTry it online at [readmegen-web-demo.vercel.app](https://readmegen-web-demo.vercel.app) — paste any GitHub URL to generate a README via the GitHub API.\n\n## License\n\nMIT\n\n---\n\n_README generated by [readmegen](https://github.com/Cravex1862/readmegen)_\n","readmeFilename":"README.md","_rev":"1-165896123ff4477efd13fffbbfd97060"}