repomix
Original:🇺🇸 English
Translated
2 scriptsChecked / no sensitive code detected
Repository packaging for AI/LLM analysis. Capabilities: pack repos into single files, generate AI-friendly context, codebase snapshots, security audit prep, filter/exclude patterns, token counting, multiple output formats. Actions: pack, generate, export, analyze repositories for LLMs. Keywords: Repomix, repository packaging, LLM context, AI analysis, codebase snapshot, Claude context, ChatGPT context, Gemini context, code packaging, token count, file filtering, security audit, third-party library analysis, context window, single file output. Use when: packaging codebases for AI, generating LLM context, creating codebase snapshots, analyzing third-party libraries, preparing security audits, feeding repos to Claude/ChatGPT/Gemini.
15installs
Sourcesamhvw8/dot-claude
Added on
NPX Install
npx skill4agent add samhvw8/dot-claude repomixTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Repomix Skill
Repomix is a powerful tool that packs entire repositories into single, AI-friendly files. Perfect for when you need to feed codebases to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, and Gemini.
When to Use This Skill
Use this skill when:
- User needs to package a codebase for AI analysis
- Preparing repository context for LLM consumption
- Generating codebase snapshots for documentation
- Analyzing third-party libraries or repositories
- Creating AI-friendly representations of code projects
- Investigating bugs across large codebases
- Performing security audits on repositories
- Generating context for implementation planning
Core Capabilities
1. Repository Packaging
Repomix packages entire repositories into single files with:
- AI-optimized formatting with clear separators
- Multiple output formats (XML, Markdown, JSON, Plain text)
- Git-aware processing (respects .gitignore)
- Token counting for LLM context management
- Security checks for sensitive information
2. Remote Repository Support
Can process remote repositories without cloning:
- Shorthand:
npx repomix --remote yamadashy/repomix - Full URL:
npx repomix --remote https://github.com/owner/repo - Specific commits:
npx repomix --remote https://github.com/owner/repo/commit/hash
3. Comment Removal
Strips comments from supported languages when needed:
- Supported: HTML, CSS, JavaScript, TypeScript, Vue, Svelte, Python, PHP, Ruby, C, C#, Java, Go, Rust, Swift, Kotlin, Dart, Shell, YAML
- Enable with: or config file
--remove-comments
Installation
Check if installed first:
bash
repomix --versionInstall using preferred method:
bash
# npm
npm install -g repomix
# yarn
yarn global add repomix
# bun
bun add -g repomix
# Homebrew (macOS/Linux)
brew install repomixBasic Usage
Package Current Directory
bash
# Basic packaging (generates repomix-output.xml)
repomix
# Specify output format
repomix --style markdown
repomix --style json
repomix --style plain
# Custom output path
repomix -o custom-output.xmlPackage Specific Directory
bash
repomix /path/to/directoryPackage Remote Repository
bash
# Shorthand format
npx repomix --remote owner/repo
# Full URL
npx repomix --remote https://github.com/owner/repo
# Specific commit
npx repomix --remote https://github.com/owner/repo/commit/abc123Command Line Options
File Selection
bash
# Include specific patterns
repomix --include "src/**/*.ts,*.md"
# Ignore additional patterns
repomix -i "tests/**,*.test.js"
# Disable .gitignore rules
repomix --no-gitignore
# Disable default ignore patterns
repomix --no-default-patternsOutput Configuration
bash
# Output format
repomix --style markdown # or xml, json, plain
# Output file path
repomix -o output.md
# Remove comments
repomix --remove-comments
# Show line numbers
repomix --no-line-numbers # disable line numbersSecurity & Analysis
bash
# Run security checks
repomix --no-security-check # disable security scanning
# Copy to clipboard
repomix --copy # copy output to clipboard
# Verbose output
repomix --verboseConfiguration
bash
# Use custom config file
repomix -c custom-config.json
# Initialize new config
repomix --init # creates repomix.config.jsonConfiguration File
Create in project root:
repomix.config.jsonjson
{
"output": {
"filePath": "repomix-output.xml",
"style": "xml",
"removeComments": false,
"showLineNumbers": true,
"copyToClipboard": false
},
"include": ["**/*"],
"ignore": {
"useGitignore": true,
"useDefaultPatterns": true,
"customPatterns": [
"additional-folder",
"**/*.log",
"**/tmp/**"
]
},
"security": {
"enableSecurityCheck": true
}
}Ignore Patterns
.repomixignore File
Create for Repomix-specific ignore patterns (same format as .gitignore):
.repomixignore# Build artifacts
dist/
build/
*.min.js
# Test files
**/*.test.ts
**/*.spec.ts
coverage/
# Large files
*.mp4
*.zip
# Sensitive files
.env*
secrets/Precedence Order
- CLI ignore patterns (flag)
-i - file
.repomixignore - Custom patterns in config file
- file (if enabled)
.gitignore - Default patterns (if enabled)
Output Formats
XML Format (Default)
Best for structured AI consumption:
bash
repomix --style xmlMarkdown Format
Human-readable with syntax highlighting:
bash
repomix --style markdownJSON Format
For programmatic processing:
bash
repomix --style jsonPlain Text
Simple concatenation:
bash
repomix --style plainUse Cases & Examples
1. Code Review Preparation
bash
# Package feature branch for AI review
repomix --include "src/**/*.ts" --remove-comments -o feature-review.md --style markdown2. Security Audit
bash
# Package third-party library for analysis
npx repomix --remote vendor/library --style xml -o audit.xml3. Documentation Generation
bash
# Package with docs and code
repomix --include "src/**,docs/**,*.md" --style markdown -o context.md4. Bug Investigation
bash
# Package specific modules
repomix --include "src/auth/**,src/api/**" -o debug-context.xml5. Implementation Planning
bash
# Full codebase context for planning
repomix --remove-comments --copyToken Management
Repomix automatically counts tokens for:
- Individual files
- Total repository
- Per-format output
Use token counts to manage LLM context limits:
- Claude: ~200K tokens
- GPT-4: ~128K tokens
- GPT-3.5: ~16K tokens
Security Considerations
Sensitive Data Detection
Repomix uses Secretlint to detect:
- API keys and tokens
- Passwords and credentials
- Private keys
- AWS secrets
- Database connection strings
Disable if needed:
bash
repomix --no-security-checkBest Practices
- Always review output before sharing
- Use for sensitive files
.repomixignore - Enable security checks for unknown codebases
- Avoid packaging files
.env - Check for hardcoded credentials
Performance Optimization
Large Repositories
Repomix uses worker threads for parallel processing:
- Efficiently handles large codebases
- Example: facebook/react processed 29x faster (123s → 4s)
Optimization Tips
bash
# Exclude unnecessary files
repomix -i "node_modules/**,dist/**,*.min.js"
# Process specific directories only
repomix --include "src/**/*.ts"
# Disable line numbers for smaller output
repomix --no-line-numbersWorkflow Integration
With Claude Code
bash
# Package and analyze in one workflow
repomix --style markdown --copy
# Then paste into Claude for analysisWith CI/CD
bash
# Generate codebase snapshot for releases
repomix --style markdown -o release-snapshot.mdWith Git Hooks
bash
# Pre-commit hook to generate context
repomix --include "src/**" -o .context/latest.xmlCommon Patterns
Full Repository Package
bash
repomix --remove-comments --style markdown -o full-repo.mdSource Code Only
bash
repomix --include "src/**/*.{ts,tsx,js,jsx}" -i "**/*.test.*"Documentation Bundle
bash
repomix --include "**/*.md,docs/**" --style markdownTypeScript Project
bash
repomix --include "**/*.ts,**/*.tsx" --remove-comments --no-line-numbersRemote Analysis
bash
npx repomix --remote owner/repo --style xml -o analysis.xmlTroubleshooting
Issue: Output Too Large
bash
# Exclude unnecessary files
repomix -i "node_modules/**,dist/**,coverage/**"
# Process specific directories
repomix --include "src/**"Issue: Missing Files
bash
# Disable .gitignore rules
repomix --no-gitignore
# Check ignore patterns
cat .repomixignoreIssue: Sensitive Data Warnings
bash
# Review flagged files
# Add to .repomixignore
# Or disable checks: --no-security-checkImplementation Workflow
When user requests repository packaging:
-
Assess Requirements
- Identify target repository (local/remote)
- Determine output format needed
- Check for sensitive data concerns
-
Configure Filters
- Set include patterns for relevant files
- Add ignore patterns for unnecessary files
- Enable/disable comment removal
-
Execute Packaging
- Run repomix with appropriate options
- Monitor token counts
- Verify security checks
-
Validate Output
- Review generated file
- Confirm no sensitive data
- Check token limits for target LLM
-
Deliver Context
- Provide packaged file to user
- Include token count summary
- Note any warnings or issues
Best Practices
- Start with defaults: Run basic first, then refine
repomix - Use .repomixignore: Better than CLI flags for complex patterns
- Enable security checks: Especially for third-party code
- Choose right format: XML for AI, Markdown for humans
- Monitor token counts: Stay within LLM limits
- Remove comments: When focusing on logic over documentation
- Version output: Include in .gitignore, regenerate as needed
- Test patterns: Verify include/exclude work as expected
Related Tools
- Context7: For up-to-date library documentation
- Git: For repository history analysis
- Secretlint: For security scanning
- Token counters: For LLM context management
Additional Resources
- GitHub: https://github.com/yamadashy/repomix
- Documentation: https://repomix.com/guide/
- MCP Server: Available for AI assistant integration
- Claude Code Plugin: Official integration available