opensrc

获取 npm 包的源代码，为 AI 编程 Agent 提供比单纯的类型定义更深层的上下文。

为什么需要它？

在使用 AI 编程 Agent 时，类型定义和文档往往是不够的。有时 Agent 需要理解代码的实现逻辑——即它是如何在内部运作的，而不仅仅是它的接口定义。

opensrc 自动化了获取包源代码的过程，以便您的 Agent 在需要时可以引用它们。

安装

npm install -g opensrc

或者使用 npx：

npx opensrc 

使用方法

npm 包

# 获取包的源码（自动从 lockfile 检测版本）
opensrc zod

# 获取指定版本
opensrc zod@3.22.0

# 获取多个包
opensrc react react-dom next

重新运行 opensrc 会自动更新以匹配您已安装的版本，无需任何参数。

GitHub 仓库

您还可以直接从任何公共 GitHub 仓库获取源代码：

# 使用 github: 前缀
opensrc github:owner/repo

# 使用 owner/repo 简写
opensrc facebook/react

# 使用完整的 GitHub URL
opensrc https://github.com/colinhacks/zod

# 获取特定的分支或标签
opensrc owner/repo@v1.0.0
opensrc owner/repo#main

# 混合获取包和仓库
opensrc zod facebook/react

GitHub 仓库会被存储为 opensrc/owner--repo/。

管理源码

# 列出已获取的源码
opensrc list

# 移除源码（包或仓库）
opensrc remove zod
opensrc remove owner--repo

文件修改

首次运行时，opensrc 会请求权限以修改以下文件：

• .gitignore — 将 opensrc/ 添加到忽略列表中
• tsconfig.json — 将 opensrc/ 从编译排除列表中排除
• AGENTS.md — 添加一个指向源代码的章节，供 Agent 参考

您的选择会被保存到 opensrc/settings.json 中，因此不会再次提示。

若要跳过提示，请使用 --modify 标志：

# 允许文件修改
opensrc zod --modify

# 禁止文件修改
opensrc zod --modify=false

工作原理

1. 查询 npm 注册表以找到包的仓库 URL。
2. 从您的 lockfile (package-lock.json, pnpm-lock.yaml, yarn.lock) 中检测已安装的版本。
3. 在对应的 git 标签（tag）处克隆仓库。
4. 将源代码存储在 opensrc/<package-name>/ 中。
5. 如果获得许可：将 opensrc/ 添加到 .gitignore，在 tsconfig.json 中排除，并更新 AGENTS.md。

输出结构

运行 opensrc zod 后：

opensrc/
├── settings.json       # 您的修改偏好设置
├── sources.json        # 已获取包的索引
└── zod/
    ├── src/
    ├── package.json
    └── ...

sources.json 文件列出了所有已获取的包及其版本，以便 Agent 了解当前可用内容：

{
  "packages": [
    { "name": "zod", "version": "3.22.0", "path": "opensrc/zod" }
  ]
}

settings.json 文件存储了您的偏好设置：

{
  "allowFileModifications": true
}

许可证

Apache-2.0