GitHub 仓库处理
基本用法
处理公共仓库:
bash
# 使用完整 URL
repomix --remote https://github.com/user/repo
# 使用 GitHub 简写
repomix --remote user/repo你也可以直接传入 owner/repo 简写,而无需 --remote:
bash
repomix yamadashy/repomix由于 owner/repo 看起来也像相对本地路径,因此只有当不存在同名的本地文件或目录、且该仓库在 GitHub 上可访问时,Repomix 才会将其视为远程仓库。已存在的本地路径始终优先;若要强制将 owner/repo 形式的路径作为本地路径处理,请在前面加上 ./(例如 repomix ./owner/repo)。如果参数匹配该格式但仓库无法访问(例如私有仓库或拼写错误),Repomix 会回退为将其作为本地路径处理。
分支和提交选择
bash
# 指定分支
repomix --remote user/repo --remote-branch main
# 指定标签
repomix --remote user/repo --remote-branch v1.0.0
# 指定提交哈希
repomix --remote user/repo --remote-branch 935b695系统要求
- 必须安装 Git
- 需要网络连接
- 需要仓库的读取权限
输出控制
bash
# 自定义输出位置
repomix --remote user/repo -o custom-output.xml
# 使用 XML 格式
repomix --remote user/repo --style xml
# 移除注释
repomix --remote user/repo --remove-commentsDocker 使用方法
bash
# 在当前目录处理并输出
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix \
--remote user/repo
# 输出到指定目录
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix \
--remote user/repo安全性
出于安全考虑,远程仓库中的配置文件(repomix.config.*)默认不会被加载。这可以防止不受信任的仓库通过 repomix.config.ts 等配置文件执行代码。
你的全局配置和 CLI 选项仍然会正常生效。
如需信任远程仓库的配置:
bash
# 使用 CLI 标志
repomix --remote user/repo --remote-trust-config
# 使用环境变量
REPOMIX_REMOTE_TRUST_CONFIG=true repomix --remote user/repo在 --remote 模式下使用 --config 时,必须指定绝对路径:
bash
repomix --remote user/repo --config /home/user/repomix.config.json常见问题
访问问题
- 确保仓库是公开的
- 检查 Git 是否已安装
- 验证网络连接
大型仓库处理
- 使用
--include选择特定路径 - 启用
--remove-comments - 分开处理不同分支