A powerful CLI tool that packs your entire repository into a single, AI-friendly file for seamless integration with Large Language Models (LLMs) like Claude, ChatGPT, and Gemini.
- Features
- Installation
- Quick Start
- Usage
- Configuration
- Output Formats
- AI Integration Guide
- Updating
- Contributing
- License
- 🤖 AI-Optimized Output: Creates LLM-friendly file formats with clear structure and context
- 📊 Token Analytics: Tracks token usage per file and repository-wide for LLM context management
- 🎯 Smart File Selection: Intelligent file filtering with extensive ignore patterns support
- 🔄 Remote Repository Support: Direct processing of GitHub repositories without manual cloning
- ⚙️ Highly Configurable: Flexible configuration through CLI options or config files
- 📝 Multiple Output Formats: Supports Plain Text, XML, and Markdown output styles
- 🧹 Code Processing: Optional comment removal and line number addition
- 📋 Clipboard Integration: Direct copying to system clipboard for quick AI tool usage
npm install -g @mimalef70/codetreenpm install --save-dev @mimalef70/codetreenpx @mimalef70/codetreeTo update to the latest version:
npm update -g @mimalef70/codetreeTo check your current version:
codetree --versionTo see if you have the latest version:
npm view @mimalef70/codetree version- Navigate to your project directory
- Run CodeTree:
codetree- Find your packed code in
codetree.txt
# Pack current directory
codetree
# Pack specific directory
codetree path/to/directory
# Pack with specific output format
codetree --style markdown
# Pack with specific include patterns
codetree --include "src/**/*.ts,**/*.md"# Pack remote repository
codetree --remote username/repository
# Initialize configuration
codetree --init# Remove comments and empty lines
codetree --removeComments --removeEmptyLines
# Show line numbers and copy to clipboard
codetree --output-show-line-numbers --copy
# Custom output file
codetree --output custom-output.md
# Process with custom config file
codetree -c ./custom-config.json
# Show verbose output
codetree --verboseOptions:
-v, --version show version information
-o, --output <file> specify the output file name
--include <patterns> list of include patterns (comma-separated)
-i, --ignore <patterns> additional ignore patterns (comma-separated)
-c, --config <path> path to a custom config file
--copy copy generated output to system clipboard
--top-files-len <number> specify the number of top files to display
--output-show-line-numbers add line numbers to each line in the output
--style <type> specify the output style (plain, xml, markdown)
--verbose enable verbose logging for detailed output
--init initialize a new codetree.config.json file
--global use global configuration (only with --init)
--remote <url> process a remote Git repository
-h, --help display helpforcommand{
"output": {
"filePath": "codetree.txt",
"style": "plain",
"showLineNumbers": false,
"removeComments": false,
"removeEmptyLines": false,
"topFilesLength": 5,
"copyToClipboard": false,
"headerText": "",
"instructionFilePath": ""
},
"include": ["**/*"],
"ignore": {
"useGitignore": true,
"useDefaultPatterns": true,
"customPatterns": []
}
}- Local:
./codetree.config.json - Global:
- Windows:
%LOCALAPPDATA%\CodeTree\codetree.config.json - macOS:
~/.config/codetree/codetree.config.json - Linux:
~/.config/codetree/codetree.config.json
- Windows:
To create a config file:
codetree --init
# For global config
codetree --init --global================================================================
Repository Structure
================================================================
src/
index.ts
utils/
helper.ts
===============
File: src/index.ts
===============
// File content here
<repository_structure>
src/
index.ts
utils/
helper.ts
</repository_structure>
<filepath="src/index.ts">
// File content here
</file># Repository Structuresrc/ index.ts utils/ helper.ts
## File: src/index.ts
```typescript
// File content here
## 🤖 AI Integration Guide
### Best Practices
1. Choose appropriate output format based on your LLM:
- Claude: Use XML format (`--style xml`)
- GPT-4/3.5: Any format works well, but Markdown (`--style markdown`) is recommended
- Gemini: Plain text or Markdown format works best
2. Consider token limits:
- Monitor the token count summary
- Use `--top-files-len` to identify large files
- Remove comments with `--removeComments` if needed
- Remove empty lines with `--removeEmptyLines` for more compact output
### Example Prompts
```plaintext
I have exported my codebase using CodeTree. Please:
1. Analyze the overall architecture
2. Identify potential improvements
3. Review code quality and suggest optimizations
4. Check for security concerns
Use include patterns to focus on specific parts:
codetree --include "src/**/*.ts,src/**/*.tsx"Exclude unnecessary files:
codetree --ignore "**/*.test.ts,**/*.spec.ts"Remove unnecessary content:
codetree --removeComments --removeEmptyLines
Permission Errors
sudo npm install -g @mimalef70/codetree
Or fix npm permissions following npm's guide
File Path Issues
- Use quotes around paths with spaces
- Use forward slashes (/) even on Windows
Out of Memory
- Process specific directories:
codetree ./src - Use include patterns:
codetree --include "src/**/*.js"
- Process specific directories:
codetree --verboseContributions are welcome! See our Contributing Guide for details on:
- Development Setup
- Pull Request Process
- Coding Standards
# Clone the repository
git clone https://github.com/mimalef70/codetree.git
cd codetree
# Install dependencies
npm install
# Build
npm run build
# Link for local development
npm linkMade with ❤️ by Mostafa Alahyari
If you find CodeTree helpful, please consider giving it a ⭐️ on GitHub