ContextQMD
Back to Repomix

GitHub Repository Processing

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

1.17.04.3 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

You can also pass the owner/repo shorthand directly, without --remote:

bash
repomix yamadashy/repomix

Since owner/repo also looks like a relative local path, Repomix only treats it as a remote repository when no local file or directory of that name exists and the repository is reachable on GitHub. A matching local path always takes precedence; to force local handling for an owner/repo-shaped path, prefix it with ./ (for example, repomix ./owner/repo). If the argument matches the pattern but the repository cannot be reached (for example, a private repository or a typo), Repomix falls back to handling it as a local path.

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

::: warning --remote-trust-config grants the remote repository's config the same trust as your own machine. A trusted config can run arbitrary commands (via input.processors) and read local files outside the repository (e.g. via output.instructionFilePath or include patterns using ../). Only use it for repositories you fully trust and have reviewed — the same caution you would apply before running npm install or a Makefile from an unfamiliar source. :::

Confirmation prompt

When you trust a repository's config in an interactive terminal, repomix shows the config that is about to run and asks you to confirm before loading it:

  • Yes, once — trust this run only.
  • Yes, and don't ask again for this repository — remembered until your temporary files are cleared, and only while that config file is unchanged (an edited config prompts again). Note that this covers the config file itself: a .ts / .js config can import other files, and those are not part of the check.
  • No — abort without running the config.

The prompt is skipped when you pass --force, in non-interactive shells such as CI (the config is trusted as before, keeping existing automation working), or once you have chosen to always trust that repository.

For the full trust model — what a trusted config can do, how the displayed config is protected from tampering, and where the "don't ask again" decision is stored — see Security.

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