Repomix 安装指南:npx 零安装、全局安装、Docker 与浏览器扩展全解析 Repomix 安装指南npx 零安装、全局安装、Docker 与浏览器扩展全解析【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomixRepomix 是一款将整个代码仓库打包为单一、AI 友好文件的命令行工具便于你将代码库直接投喂给 Claude、ChatGPT、DeepSeek 等 LLM 或 AI 工具。本文基于官方安装文档系统梳理从 npx 零安装、npm/Yarn/pnpm/Bun/Homebrew 全局安装到 Docker 容器化、VS Code 扩展与浏览器扩展的完整安装路径并结合本仓库源码如 package.json、Dockerfile、src/cli/cliRun.ts说明底层实现与验证方法。读完本文你将能根据自身环境选择最合适的安装方式并完成安装后的正确性校验。快速体验使用 npx无需安装如果只是临时使用或想先验证 Repomix 是否满足需求最轻量的方式是借助 npm 自带的 npx 直接执行最新版无需任何本地安装npx repomixlatest该命令会临时拉取并运行 Repomix默认将当前目录下的仓库打包为repomix-output.xml在仓库根目录下直接运行npx repomixlatest即可复现这一行为。这种方式适合 CI 脚本、一次性任务以及不希望污染全局环境的场景每次执行都会获取最新版本代价是首次运行需要等待下载。全局安装五种包管理器任选需要频繁使用 Repomix 时建议全局安装。官方文档提供了五种方式# npm npm install -g repomix # Yarn yarn global add repomix # pnpm pnpm add -g repomix # Bun bun add -g repomix # HomebrewmacOS brew install repomix安装后repomix命令将直接可用。在仓库的 package.json 中可以看到bin: ./bin/repomix.cjs即 npm 安装包会通过该入口将repomix命令注册到系统 PATH同时type: module表明包以 ESM 形式发布主入口为./lib/index.js。无论使用哪种包管理器最终都会得到一致的 CLI 体验。Docker 安装免环境依赖的容器化方案对于不想在宿主机安装 Node.js 的环境官方提供了 Docker 镜像ghcr.io/yamadashy/repomix。核心用法是将本地目录挂载到容器的/app工作目录# 打包当前目录 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix # 打包指定子目录 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory # 处理远程仓库结果输出到 ./output docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix镜像的构造方式可以直接从仓库根目录的 Dockerfile 中确认基础镜像为node:22-slim并通过apt-get安装了git与ca-certificates——其中git正是文档系统要求中处理远程仓库需要 Git这一前提的容器内体现在镜像构建阶段执行npm ci npm link将 Repomix 全局链接到镜像内随后npm prune --omitdev精简生产依赖构建末尾执行RUN repomix --version与RUN repomix --help做自检确保镜像开箱即用最后以ENTRYPOINT [repomix]声明容器入口因此docker run ... ghcr.io/yamadashy/repomix等价于直接执行repomix命令后面的path/to/directory、--remote yamadashy/repomix都会作为其参数传递。其中--remote用于克隆并打包远程仓库支持 GitHub 完整 URL 或owner/repo简写形式对应 src/cli/cliRun.ts 中--remote url选项的声明。系统要求官方文档明确列出两项硬性要求Node.js ≥ 22.0.0这一版本门槛与仓库根 package.json 中engines: { node: 22.0.0 }完全一致。需要说明的是仅当通过 npx 或全局安装npm/Yarn/pnpm/Bun方式运行时才依赖本机 Node.jsDocker 方式由于镜像内已内置 Node 22宿主机无需安装。Git仅在使用--remote处理远程仓库时需要本地目录打包不依赖 Git若使用--include-diffs、--include-logs等 Git 相关功能则同样需要 Git 环境。安装验证安装完成后用下面两条命令确认 CLI 可用repomix --version repomix --help--version会输出当前版本号。其实现位于 src/cli/actions/versionAction.ts通过getVersion()见 src/core/file/packageJsonParse.ts从package.json读取版本并打印。本文撰写时仓库对应版本为 1.18.0见 package.json你本机输出的版本号应与之相近或更新。--help会列出全部 CLI 选项。在 src/cli/cliRun.ts 中可以看到这些选项按功能分组注册基础选项--version、输入输出选项--verbose、--stdout、--copy、--token-count-tree等、输出格式选项--style、--compress、--remove-comments、--split-output等、文件选择选项--include、--ignore、远程仓库选项--remote、--remote-branch、配置选项--config、--init、--global、安全选项--no-security-check、Token 预算--token-budget、MCP 模式--mcp、--sandbox、技能生成--skill-generate以及监听模式--watch。--help是快速了解 Repomix 全部能力的最佳入口。VS Code 扩展图形化一键打包官方文档推荐由社区维护的Repomix Runner扩展可直接在 VS Code 中运行 Repomix无需切换到终端。其主要功能包括只需几次点击即可打包任意文件夹可选择文件模式或内容模式进行复制前者仅拷贝打包结果文件后者将打包内容直接写入剪贴板自动清理输出文件与repomix.config.json配置文件协同工作该文件可通过下文提到的--init命令生成。扩展可在 VS Code Marketplace 中搜索 Repomix Runner 安装。浏览器扩展在 GitHub 仓库页一键调用官方还提供浏览器扩展可在任意 GitHub 仓库页面直接使用 Repomix。安装后GitHub 仓库页面会出现一个 Repomix 按钮点击即可一键完成该仓库的打包访问无需复制仓库 URL 或切换命令行。Chrome 扩展可在 Chrome Web Store 搜索 Repomix 安装Firefox 附加组件可在 Firefox Add-ons 中安装。该扩展的源码位于本仓库的 browser/ 目录其 browser/package.json 显示该项目基于 WXT 框架开发支持构建 Chrome、Firefox 与 Edge 三种目标build:chrome、build:firefox、build:edge并包含repomix-integration.test.ts等测试见 browser/tests/repomix-integration.test.ts。核心逻辑中browser/entrypoints/content.ts 负责在 GitHub 页面注入按钮browser/entrypoints/background.ts 负责后台任务处理browser/utils/github-navigation.ts 封装了 GitHub 页面导航相关逻辑。需要说明的是浏览器扩展的开发环境要求 Node.js ≥ 24.0.1见 browser/package.json 的engines字段高于 CLI 本身的 22.0.0 门槛仅对想要自行构建扩展的开发者有约束。安装后的下一步安装并验证成功后建议先运行repomix打包当前目录生成一份输出文件直观感受工具效果。若希望调整默认行为可运行repomix --init该命令会以交互式方式在当前目录生成repomix.config.json支持选择输出风格与输出文件路径并可选择创建.repomixignore文件其实现位于 src/cli/actions/initAction.ts交互基于clack/prompts完成可通过--global选项将配置写入用户主目录见 src/config/globalDirectory.ts。接下来可以深入阅读本仓库的官方文档继续学习基础用法指南学习如何使用 Repomix 打包目录、远程仓库与指定文件配置指南通过repomix.config.json定制打包行为命令行选项参考完整 CLI 参数速查。安装方式的选择取决于你的使用场景临时体验用 npx日常使用选全局安装追求环境隔离用 Docker终端图形化操作偏好用 VS Code 扩展高频访问 GitHub 仓库则推荐浏览器扩展。【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考