opensrc

环境要求

• Node.js 环境（使用 npm 全局安装 CLI 需要）
• Node.js 24+、pnpm 11（仅从源码开发时需要）
• Rust/Cargo（仅编译 packages/opensrc/cli 时需要）
• ripgrep（示例中的 rg 搜索命令依赖它）

安装与启动步骤

1. 1安装 opensrc CLI

   用 npm 全局安装 opensrc，装好后即可在任意目录调用 opensrc 命令。

   npm install -g opensrc

   复制

2. 2获取包源码路径

   以 zod 为例，首次执行会拉取源码并缓存，之后直接返回本地路径。

   opensrc path zod

   复制

3. 3在源码中搜索

   把路径命令的输出作为目录交给 rg，就能在依赖源码里搜索关键字。

   rg "parse" $(opensrc path zod)

   复制

4. 4读取指定文件

   在返回的路径后拼接文件相对路径，用 cat 查看具体实现。

   cat $(opensrc path zod)/src/types.ts

   复制

5. 5使用其他源

   支持 PyPI 等源，用 pypi: 前缀指定包名，再用 find 查找文件。

   find $(opensrc path pypi:requests) -name "*.py"

   复制

6. 6搭建开发环境

   参与开发时先装依赖再用 turbo 构建，仓库为 pnpm 工作区单仓。

   pnpm install
   turbo build

   复制

7. 7构建 Rust CLI

   修改 CLI 后可单独编译 Rust 侧代码进行验证。

   cargo build --manifest-path packages/opensrc/cli/Cargo.toml

   复制

如何确认成功

执行 opensrc path zod 能返回本地缓存路径，且该路径下能看到 zod 源码文件即为成功。

常见问题

注意事项

• opensrc path 首次使用会拉取源码并缓存，后续直接返回缓存路径。
• 示例里的 $(opensrc path <包名>) 属于 bash 命令替换，其他终端需改用对应写法。
• 开发环境要求 Node.js 24+ 与 pnpm 11。