1.0.2 • Published 5 months ago
llm-codebase-scanner v1.0.2
LLM Codebase Scanner
A powerful command-line tool for scanning codebases, with special support for .NET solutions. This creates a markdown file which can be used as the context for Large Language Models.
Features
- 📁 Generates comprehensive markdown documentation of your codebase structure, ready for use as context when prompting a LLM like ChatGPT or Claude
- 🔍 Analyzes .NET solution and project files
- 📝 Includes all of your source code
- 🎨 Beautiful console output with progress indicators
- 🎯 Configurable file extensions and ignore patterns
Installation
npm install -g llm-codebase-scanner
Usage
llm-codebase-scanner [options]
Options
-i, --input <path>
- Input directory path (default: current directory)-o, --output <path>
- Output markdown file path (default: codebase-documentation.md)-v, --verbose
- Enable verbose logging--ignore <dirs>
- Comma-separated list of directories to ignore--extensions <exts>
- Comma-separated list of file extensions to include--no-solution
- Skip solution file analysis--version
- Show version number--help
- Show help
Examples
Scan current directory:
llm-codebase-scanner
Scan specific directory:
llm-codebase-scanner -i /path/to/project
Customize ignored directories:
llm-codebase-scanner --ignore "node_modules,dist,build"
License
MIT
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.