ContextQMD
Back to Repomix

GitHub Repository Processing

website/client/src/en/guide/remote-repository-processing.md

1.14.02.2 KB
Original Source

GitHub Repository Processing

Basic Usage

Process public repositories:

bash
# Using full URL
repomix --remote https://github.com/user/repo

# Using GitHub shorthand
repomix --remote user/repo

Branch and Commit Selection

bash
# Specific branch
repomix --remote user/repo --remote-branch main

# Tag
repomix --remote user/repo --remote-branch v1.0.0

# Commit hash
repomix --remote user/repo --remote-branch 935b695

Requirements

  • Git must be installed
  • Internet connection
  • Read access to repository

Output Control

bash
# Custom output location
repomix --remote user/repo -o custom-output.xml

# With XML format
repomix --remote user/repo --style xml

# Remove comments
repomix --remote user/repo --remove-comments

Docker Usage

bash
# Process and output to current directory
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix \
  --remote user/repo

# Output to specific directory
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix \
  --remote user/repo

Security

For security, config files (repomix.config.*) in remote repositories are not loaded by default. This prevents untrusted repositories from executing code via config files such as repomix.config.ts.

Your global config and CLI options are still applied.

To trust a remote repository's config:

bash
# Using CLI flag
repomix --remote user/repo --remote-trust-config

# Using environment variable
REPOMIX_REMOTE_TRUST_CONFIG=true repomix --remote user/repo

When using --config with --remote, an absolute path is required:

bash
repomix --remote user/repo --config /home/user/repomix.config.json

Common Issues

Access Issues

  • Ensure repository is public
  • Check Git installation
  • Verify internet connection

Large Repositories

  • Use --include to select specific paths
  • Enable --remove-comments
  • Process branches separately