
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/repomix导读Repomix 是一款将整个代码仓库打包为单一 AI 友好文件XML / Markdown / Plain Text / JSON的命令行工具便于将代码库直接投喂给 Claude、ChatGPT、DeepSeek、Gemini 等大语言模型。本指南以官方安装文档为主体结合仓库源码系统讲解 npx 免安装体验、npm/Yarn/pnpm/Bun/Homebrew 全局安装、项目级依赖安装、Docker 容器化运行、VS Code 与浏览器扩展以及安装后的版本验证方法。读完本文你将掌握在本地、CI 与容器环境中正确部署 Repomix 的全部途径并能验证安装是否生效。环境要求在安装之前请先确认运行环境满足以下前提依赖版本要求用途Node.js≥ 22.0.0运行 Repomix CLI 的运行时Git必需处理远程仓库时远程仓库处理--remote等以上要求直接来源于仓库 package.json 的engines字段node: 22.0.0。需要说明的是CLI 启动脚本 bin/repomix.cjs 对 Node.js 版本低于 20 的环境仅输出警告“Repomix recommends Node.js version 20 or higher”仍会尝试继续运行但部分特性可能异常因此建议严格使用 22 及以上版本。使用 npx免安装即刻体验如果只是想尝试 Repomix或只需在某个项目上运行一次无需任何全局安装直接执行npx repomixlatestnpx 会临时拉取repomix的最新发布版本并立即执行不会污染全局环境。这种方式非常适合首次体验验证 Repomix 是否满足需求临时处理一个仓库不想安装任何依赖在 CI 流水线中按需调用详见后文 GitHub Actions 一节。全局安装将 repomix 变为系统命令全局安装后即可在任意目录直接执行repomix命令。官方文档提供了五种包管理方式的等价命令# npm npm install -g repomix # Yarn yarn global add repomix # pnpm pnpm add -g repomix # Bun bun add -g repomix # HomebrewmacOS / Linux brew install repomix从源码结构看全局安装后系统会通过 bin/repomix.cjs 这个可执行入口注册repomix命令package.json 的bin: ./bin/repomix.cjs即声明了这一点。该入口启用 Node.js 编译缓存enableCompileCache以加速 ESM 模块加载并注册了uncaughtException、unhandledRejection、SIGINT、SIGTERM等错误与退出处理最后动态导入lib/cli/cliRun.js的run()启动 CLI。项目级安装作为项目依赖使用把 Repomix 安装为项目的本地依赖便于团队统一版本、配合package.json脚本使用# npm npm install --save-dev repomix # Yarn yarn add --dev repomix # pnpm pnpm add -D repomix三个命令均将 Repomix 安装为devDependencies开发依赖适合在构建、代码生成或 CI 场景中通过npx repomix或项目脚本调用。安装后可在项目的package.json中通过scripts定义快捷命令例如pack: repomix再以npm run pack触发。使用 Docker容器化运行Repomix 官方提供了容器镜像ghcr.io/yamadashy/repomix适合需要隔离环境、避免污染本机 Node 环境的场景。基础用法为# 处理当前目录 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix其中-v .:/app把当前目录挂载为容器内的/app工作目录-it开启交互式终端--rm容器退出后自动删除。官方英文文档还补充了两种实用变体# 处理指定子目录 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额外安装git与ca-certificatesgit 用于远程仓库处理证书用于 HTTPS 下载通过npm ci安装依赖后用npm link将 Repomix 全局链接再执行npm prune --omitdev精简体积镜像以ENTRYPOINT [repomix]直接作为命令入口并在构建期执行repomix --version与repomix --help自检。VS Code 扩展社区维护的Repomix Runner扩展可让开发者直接在 VS Code 内运行 Repomix无需切换到终端。其主要特性包括点击几下即可打包任意文件夹可选“文件模式 / 内容模式”两种复制方式输出文件的自动清理原生支持读取repomix.config.json配置。可前往 VS Code Marketplace 搜索 “Repomix Runner”扩展 IDDorianMassoulier.repomix-runner安装。浏览器扩展在 GitHub 页面一键直达安装浏览器扩展后访问任意 GitHub 仓库页面时页面导航栏会多出一个 “Repomix” 按钮点击即可直达该仓库的 Repomix 处理页面实现“零复制、零命令”的极速打包体验。安装方式Chrome在 Chrome Web Store 中搜索 “Repomix” 并安装Firefox在 Firefox Add-ons 中搜索 “Repomix” 并安装。扩展的实现原理该扩展的源码位于仓库的 browser 目录基于 WXT 框架构建。其核心逻辑在 browser/entrypoints/content.ts 中内容脚本Content Script仅匹配https://github.com/*页面wxt.config.ts 中的host_permissions与matches配置通过解析window.location.pathname提取仓库的owner与repo信息借助 browser/utils/github-navigation.ts 定位 GitHub 页面导航容器把 “Repomix” 按钮插入导航栏最左侧按钮链接指向https://repomix.com/?repo仓库URL从而实现一键跳转打包使用MutationObserver监听 GitHub 动态渲染的 DOM 变化GitHub 是 SPA 风格页面并监听popstate事件处理前进/后退导航确保按钮始终存在。扩展特性任意 GitHub 仓库的 One-Click一键Repomix 访问官方表示更多功能正在规划中coming soon。与 GitHub Actions 集成Repomix 也可作为 GitHub Actions 中的 Action 使用实现 CI/CD 流水线内的自动化打包。官方印地语文档提供了完整的工作流示例详见 website/client/src/hi/guide/github-actions.md核心要点如下基于actions/checkoutv7需fetch-depth: 0以获取完整历史与actions/setup-nodev6Node.js 22搭建基础环境核心执行命令为npx repomix --output-file repomix-output.xml无需预先全局安装可组合--style markdown、--include src/**/*.ts,docs/**/*.md、--ignore **/*.test.ts,**/node_modules/**、--remove-comments、--compress等高级参数通过actions/upload-artifact上传产物并可结合schedule定时触发、matrix 矩阵构建、GITHUB_TOKEN私有仓库认证、PR 评论展示摘要等进阶玩法。验证安装安装完成后建议执行以下命令确认 CLI 工作正常repomix --version repomix --helprepomix --version输出当前版本号当前仓库版本为 1.18.0repomix --help输出完整的 CLI 帮助信息与全部可用选项。从源码看版本输出的实现链路是 src/cli/actions/versionAction.ts 调用 src/core/file/packageJsonParse.ts 的getVersion()——后者读取发布包内package.json的version字段并打印若读取失败会回退返回unknown并输出警告日志。因此若此处无法显示版本号多半说明安装未完成或环境变量 PATH 未正确包含 Repomix 的可执行路径。相关资源基本用法指南学习 Repomix 的基础使用方式配置指南按需定制 Repomix 的打包行为命令行选项参考完整的 CLI 参数手册GitHub Actions 指南在 CI/CD 中自动化运行 Repomix【免费下载链接】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),仅供参考