ARTICLE · INTELLIGENCE

战地情报 · 详情页

来自尧图项目组的一线实战观察与深度解析

Repomix 安装指南:npx / npm / Yarn / Bun / Homebrew / Docker 与浏览器扩展全方案详解

Repomix 安装指南:npx / npm / Yarn / Bun / Homebrew / Docker 与浏览器扩展全方案详解 Repomix 安装指南npx / npm / Yarn / Bun / Homebrew / 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 等大语言模型使用。本文以官方安装文档为骨架系统讲解 Repomix 的全部安装方式——从零安装的npx免安装用法、npm/Yarn/pnpm/Bun/Homebrew 全局安装到 Docker 容器化运行、VSCode 扩展与浏览器扩展并给出安装后的验证方法与环境要求同时结合仓库源码说明版本命令、CLI 入口与远程仓库处理等底层实现帮助你选择最适合自己场景的安装路径。方式一使用 npx无需安装即取即用如果只是偶尔打包仓库、不想在系统里留下全局依赖直接用npx即可npx repomixlatestnpx 会临时拉取 npm 上最新的repomix包并执行无需任何预先安装步骤。这也是快速体验 Repomix 的最低成本方式适合 CI 流水线、临时机器或首次评估场景。方式二全局安装npm / Yarn / pnpm / Bun / Homebrew如果希望在任何目录下都能直接调用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安装完成后repomix命令会注册到系统 PATH。从仓库的 package.json 可以看到发布包通过bin: ./bin/repomix.cjs声明了 CLI 可执行入口type: module表明项目采用 ESM 模块体系main指向./lib/index.js这意味着安装后除了命令行工具还可以在 Node 项目中以库的形式import { pack } from repomix调用其编程接口详见 src/index.ts 中的导出清单。方式三Docker 容器化运行对于不想污染本机环境、或需要在隔离环境中运行的用户官方提供了已构建好的 Docker 镜像ghcr.io/yamadashy/repomix。基本用法如下# 打包当前目录 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix # 打包指定子目录 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory # 打包远程 GitHub 仓库 docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix三个示例对应三类典型场景当前目录-v .:/app将当前目录挂载为容器工作目录--rm确保运行结束即清理容器-it保留交互终端指定子目录把path/to/directory作为位置参数传入Repomix 会在挂载目录内定位并打包该子目录远程仓库借助--remote选项直接指定 GitHub 仓库支持user/repo简写或完整 URL输出目录挂载到宿主机的./output以便取回结果。镜像的构建逻辑可以从仓库根目录的 Dockerfile 确认基础镜像为node:22-slim安装git与ca-certificatesgit 用于远程仓库克隆通过npm ci npm link将 repomix 链接到全局并将工作目录设为/app最后设置ENTRYPOINT [repomix]因此容器启动即直接进入 repomix 命令。需要说明的是远程打包模式下容器内需要 git 且网络可达--remote的处理流程可参考 remoteAction.ts其优先尝试 GitHub 归档下载失败后再回退到 git 浅克隆整个过程在临时目录中进行完成后输出文件会被复制到当前目录或--stdout直接输出。方式四VSCode 扩展Repomix Runner在 VSCode 中可以直接通过社区扩展 Repomix Runner 使用 Repomix无需打开终端。扩展的核心特性只需几次点击即可打包任意文件夹支持在文件模式与内容模式之间选择复制方式自动清理输出文件兼容repomix.config.json配置。在 VSCode 扩展市场搜索 Repomix Runner 并安装即可需本地先具备 Node.js 环境。方式五浏览器扩展Chrome / Firefox浏览器扩展让你从任意 GitHub 仓库页面一键直达 Repomix 打包服务免去复制 URL、拼装命令的麻烦。扩展会在 GitHub 仓库页面插入一个醒目的 Repomix 按钮点击后跳转到打包页面完成处理。安装入口ChromeRepomix Chrome 扩展Chrome Web StoreFirefoxRepomix 浏览器扩展Firefox Add-ons功能特性对任意 GitHub 仓库提供一键式 Repomix 访问更多功能持续迭代中。从仓库内的扩展源码可以进一步了解其工作机制。扩展基于 Wxt 框架开发见 browser/package.json其入口逻辑在 browser/entrypoints/content.ts内容脚本监听https://github.com/*页面通过解析 URL 路径提取仓库的 owner 与 repo 信息在 GitHub 仓库导航栏中动态注入带 Repomix 图标的按钮并借助MutationObserver适配 GitHub 的单页动态导航browser/entrypoints/background.ts 则在后台负责向符合条件的 GitHub 标签页注入样式与脚本。值得注意的是仓库本身还提供了build:firefox、build:edge等构建脚本见 browser/package.json说明扩展的可构建目标不止 Chrome 一种。系统要求与前置条件依赖要求说明Node.js≥ 22.0.0运行 Repomix 的运行时下限Git必需仅处理远程仓库时需要Node.js 版本要求与仓库 package.json 中engines字段的声明完全一致node: 22.0.0安装前建议用node --version确认当前版本满足要求。Git 则仅在处理远程仓库--remote或位置参数传入远程 URL时才被调用——从 remoteAction.ts 可以看出代码会先尝试 GitHub 归档直接下载只有归档方式不可用时才检查 git 是否安装并执行浅克隆因此纯本地打包可以不需要 Git。安装后的验证安装完成后建议先验证命令是否可用、版本是否符合预期repomix --version repomix --help--version输出当前安装的版本号便于与官方发布版本核对--help打印完整的命令用法与全部选项说明。这两个命令的行为可以在源码中找到对应实现CLI 基于 commander 构建见 cliRun.ts定义了-v, --version与--help等选项--version实际调用 versionAction.ts从项目 package.json 中读取版本号并打印。作为佐证仓库的 Dockerfile 在镜像构建阶段也执行了repomix --version与repomix --help来检查 repomix 安装是否正常这与你安装后应做的验证步骤完全一致。验证通过后的下一步安装并验证完成后就可以正式使用了。官方文档建议的进阶路径使用指南学习 Repomix 的基本使用方法配置指南按需自定义 Repomix 的行为命令行选项查阅完整的 CLI 参数参考。值得一提的是仓库还提供了交互式初始化命令repomix --init它会在当前目录引导创建repomix.config.json与.repomixignore文件实现见 initAction.ts让你不用手写配置即可快速建立符合自己需求的项目配置是安装完成后快速上手的好帮手。小结如何选择安装方式场景推荐方式快速体验、一次性使用npx repomixlatest日常高频使用、多项目通用npm / Yarn / pnpm / Bun 全局安装macOS 用户偏好系统包管理brew install repomix隔离环境、避免污染宿主机Docker 镜像ghcr.io/yamadashy/repomix习惯在编辑器内操作VSCode 扩展 Repomix Runner经常浏览 GitHub 仓库Chrome / Firefox 浏览器扩展无论选择哪种方式安装完成后都可以用repomix --version与repomix --help快速确认环境就绪然后开始把任意仓库打包成单个 AI 友好文件。【免费下载链接】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),仅供参考
RELATED READING

延伸阅读

更多一线实战笔记与深度复盘,助您持续精进