smart-repomix
Version:
AI-powered wrapper for repomix that intelligently filters unnecessary files
50 lines (40 loc) • 1.76 kB
Markdown
# Smart Repomix - File Structure
Here are all the files you need to create for the smart-repomix package:
```
smart-repomix/
├── package.json # Package configuration
├── cli.js # CLI entry point (make executable with chmod +x)
├── index.js # Main logic
├── README.md # Documentation
├── .gitignore # Git ignore patterns
├── example-usage.js # Example usage script
├── repomix.config.json.example # Example configuration
├── QUICKSTART.md # Quick start guide
├── PUBLISHING.md # Publishing instructions
├── ADVANCED.md # Advanced usage guide
└── FILES.md # This file
```
## File Descriptions
- **package.json**: Defines the package metadata, dependencies, and npm scripts
- **cli.js**: Command-line interface that handles user input and options
- **index.js**: Core logic that orchestrates the repomix filtering process
- **README.md**: Main documentation for users
- **.gitignore**: Prevents committing unnecessary files
- **example-usage.js**: Shows how to use the package programmatically
- **repomix.config.json.example**: Example configuration showing smart-repomix options
- **QUICKSTART.md**: Step-by-step setup instructions
- **PUBLISHING.md**: Guide for publishing to npm
- **ADVANCED.md**: Advanced usage patterns and tips
## Setup Commands
After creating all files:
```bash
# Install dependencies
npm install
# Make CLI executable (Unix/Mac)
chmod +x cli.js
# Test the setup
node cli.js --help
# Copy example config (optional)
cp repomix.config.json.example repomix.config.json
# Then edit repomix.config.json with your API key
```