opensrc

opensrc

パッケージやリポジトリのソースコードを取得し、AI コーディングエージェントに実装の詳細なコンテキストを提供する CLI ツールです。

使用する場面

• ライブラリやパッケージの内部の仕組みを把握する必要がある場合（インターフェースだけでは不十分な場合）
• 型情報だけでは不十分な問題をデバッグする場合
• 依存関係にあるパッケージの実装パターンを調べる場合
• エージェントがパッケージの実際のソースコードを参照する必要がある場合

クイックスタート

# Install globally or use npx
npm install -g opensrc

# Fetch npm package (auto-detects installed version from lockfile)
npx opensrc zod

# Fetch from other registries
npx opensrc pypi:requests       # Python/PyPI
npx opensrc crates:serde        # Rust/crates.io

# Fetch GitHub repo directly
npx opensrc vercel/ai           # owner/repo shorthand
npx opensrc github:owner/repo   # explicit prefix
npx opensrc https://github.com/colinhacks/zod  # full URL

# Fetch specific version/ref
npx opensrc [email protected]
npx opensrc owner/[email protected]

コマンド

コマンド	説明
opensrc <packages...>	パッケージやリポジトリのソースを取得します
opensrc list	取得済みのソースを一覧表示します
opensrc remove <name>	指定したソースを削除します
opensrc clean	すべてのソースを削除します

出力構成

取得したソースは opensrc/ ディレクトリに保存されます。

opensrc/
├── settings.json           # User preferences
├── sources.json            # Index of fetched packages/repos
└── repos/
    └── github.com/
        └── owner/
            └── repo/       # Cloned source code

ファイルの変更

初回実行時、opensrc は次のファイルの変更を促します。

• .gitignore - 無視リストに opensrc/ を追加します
• tsconfig.json - コンパイル対象から opensrc/ を除外します
• AGENTS.md - エージェントにソースコードの場所を知らせるセクションを追加します

プロンプトをスキップするには、--modify または --modify=false を使用します。

主な動作

1. バージョンの検出 - npm の場合、node_modules、package-lock.json、pnpm-lock.yaml、または yarn.lock からインストール済みのバージョンを自動検出します
2. リポジトリの解決 - レジストリ API を通じてパッケージの Git リポジトリを特定し、一致するタグを指定してクローンします
3. モノレポのサポート - repository.directory フィールドを通じて、モノレポ内のパッケージを処理します
4. シャロークローン - 効率的なクローンのために --depth 1 を使用し、クローン後に .git を削除します
5. タグのフォールバック - タグが見つからない場合は、v{version}、{version}、デフォルトブランチの順に試します

よくあるワークフロー

パッケージの取得

# Agent needs to understand zod's implementation
npx opensrc zod
# → Detects version from lockfile
# → Finds repo URL from npm registry
# → Clones at matching git tag
# → Source available at opensrc/repos/github.com/colinhacks/zod/

ソースの更新

# Re-run same command to update to currently installed version
npx opensrc zod
# → Checks if version changed
# → Re-clones if needed

複数のソース

# Fetch multiple at once
npx opensrc react react-dom next
npx opensrc zod pypi:pydantic vercel/ai

参考資料

詳しい情報については、以下を参照してください。

• CLI の使い方とオプション - コマンドの全リファレンス
• アーキテクチャ - コード構成と拡張
• レジストリのサポート - npm、PyPI、crates.io の詳細