Blazing Fast
Regex parsing, no API calls, runs in milliseconds
Hallucination-Free
Extracts exact routes, schemas, and env vars directly from source code
AI Mode
Add --ai to get Copilot-style prose powered by Claude, grounded in confirmed facts
Why Choose grepme-x?
Built for developers who value speed, accuracy, and privacy
Lightning Fast
Generate complete READMEs in milliseconds using pure regex patterns, no network calls or AI processing delays.
Accurate & Honest
No AI hallucinations or made-up features. Every line extracted directly from your actual source code.
Privacy First
Runs entirely offline on your machine. Your code never leaves your computer or hits any external API.
Zero Config
Works out of the box with sensible defaults. Customize with powerful CLI flags when you need control.
Lightweight
Minimal dependencies and fast execution. Less than 1MB footprint with instant performance.
Developer Friendly
Simple CLI interface. Perfect for CI/CD pipelines, pre-commit hooks, and automated documentation.
How It Works
Drop it in
copy grepme-x.mjs into any Node.js project
Run it
node grepme-x.mjs
Done
README.md generated with routes, auth, Docker, schemas, and env vars
Get Started in Seconds
Install grepme-x using your favorite package manager
npm
npm install -g grepme-xInstall globally from npm registry
yarn
yarn global add grepme-xInstall globally using yarn
pnpm
pnpm add -g grepme-xInstall globally using pnpm
Then run it on your project:
$ grepme-xThis will generate a beautifully formatted README.md in your project root based on your actual codebase.
Two Modes
API Routes
| Method | Path | Auth |
|---|---|---|
| GET | /api/users | JWT |
| POST | /api/auth/login | None |
| DELETE | /api/users/:id | JWT |
Environment Variables
What It Extracts
API Routes
Express, Fastify, Next.js App Router, Pages Router
Auth Detection
Passport, JWT, NextAuth, Clerk, Supabase, Firebase and 15 more
Docker Info
Services, ports, volumes, and generated run commands
DB Schemas
Mongoose, Sequelize, Prisma
Env Variables
All process.env references output as a ready-to-fill .env template
File Tree
Visual project structure up to 3 levels deep
Perfect For Every Use Case
From indie developers to large teams
Open Source Projects
Keep your README.md in sync with your code automatically. Perfect for maintaining accurate documentation across versions.
Team Collaboration
Generate consistent, standardized documentation for team projects. Reduce documentation overhead in PRs and code reviews.
CI/CD Pipelines
Integrate into your CI/CD workflow. Automatically update documentation on every push or release.
Pre-commit Hooks
Keep your documentation fresh before every commit. Ensure README never falls out of sync with your code.
API Documentation
Extract route definitions, middleware, and authentication details directly from your Express/Fastify applications.
Project Scaffolding
Generate initial documentation when creating new projects or microservices with boilerplate code.
How grepme-x Compares
The smarter alternative to AI-powered and manual documentation
| Feature | grepme-x | AI Tools | Manual Work |
|---|---|---|---|
| Speed | ✓ Milliseconds | ○ Seconds to minutes | ○ Manual work |
| Accuracy | ✓ 100% factual | ○ Prone to hallucinations | ○ Human error prone |
| Privacy | ✓ Offline only | ○ Sends data to servers | ✓ Local only |
| Cost | ✓ Free | ○ API usage fees | ○ Staff time |
| Setup | ✓ Zero config | ○ API keys required | ○ Manual process |
| Maintenance | ✓ Auto-sync | ○ Manual updates | ○ Always outdated |
| Integration | ✓ CI/CD ready | ○ Limited tooling | ○ Not automated |
| Customization | ✓ Regex patterns | ○ Prompt tuning | ✓ Full control |
The best documentation is one that's always accurate and always up-to-date.
grepme-x achieves this by extracting facts directly from your source code, with zero hallucinations and maximum speed.
CLI Flags
| Flag | Short | Default | Description |
|---|---|---|---|
| --output | -o | README.md | Output file name |
| --ignore | -i | "" | Comma-separated dirs to ignore |
| --format | -f | markdown | Output format: markdown or json |
| --ai | -a | false | Claude-powered prose README |
| --key | -k | "" | Anthropic API key |
| --model | -m | claude-opus-4-6 | Claude model to use |