opensrc

When you run opensrc path <package>, the tool performs the following steps to locate and provide the source code:

1. Registry lookup: Queries the registry (e.g., npm) for package metadata.
2. Repository detection: Extracts the repository field from package.json to find the source URL.
3. Version tagging: Maps the version to a git tag.
4. Shallow clone: Performs a git clone --depth 1 for the specific version.
5. Cache storage: Saves the source in the local cache.
6. Path output: Prints the absolute path to stdout (progress information is sent to stderr to ensure compatibility with subshells).

Subsequent requests for the same package and version skip steps 1-4 and return the cached path immediately.

The opensrc path command supports various registries by using a prefix. This allows you to explore source code for PyPI, Crates.io, or GitHub packages.

Examples:

• PyPI: pypi:<package>
• Crates.io: crates:<package>
• GitHub: <user>/<repo>

find $(opensrc path pypi:requests) -name "*.py"
ls $(opensrc path crates:serde)/src/
grep -r "Router" $(opensrc path vercel/next.js)/packages/next/src/

Combine opensrc path <package> with standard file utilities like cat to read the contents of a specific file within a package's source tree.

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

The documentation site is built with Next.js. To run it locally:

cd apps/docs
pnpm dev

To resolve Python packages from PyPI, use the pypi: prefix before the package name.

find $(opensrc path pypi:requests) -name "*.py"
cat $(opensrc path pypi:flask)/src/flask/app.py
opensrc path pypi:pydantic

To access private GitHub repositories and increase your API rate limit from 60 to 5,000 requests/hour, set the GITHUB_TOKEN environment variable.

Required permissions:

• Fine-grained PAT: read-only "Contents" access to the target repositories.
• Classic PAT: repo scope.

Tokens are used for both resolving the default branch via the GitHub API and for git clone operations over HTTPS.

export GITHUB_TOKEN=ghp_your_token_here
opensrc path vercel/private-repo

This project is a Turborepo monorepo using pnpm workspaces. To develop locally, ensure you are using Node.js 24+ and pnpm 11.

Run the following commands to install dependencies and start the build/dev processes:

pnpm install
turbo build
turbo dev

Install the opensrc CLI globally to provide coding agents and other tools with access to package source code via the opensrc path command.

npm install -g opensrc

To access private Bitbucket repositories, set the BITBUCKET_TOKEN environment variable.

Requirements:

• Use a workspace, project, or repository access token with read access to the repository.
• Bitbucket Cloud is phasing out app passwords; access tokens are preferred.

Tokens are used for both resolving the default branch via the Bitbucket API and for git clone operations over HTTPS.

export BITBUCKET_TOKEN=your_access_token
opensrc path bitbucket:workspace/private-repo

To resolve repositories from Bitbucket, use the bitbucket: prefix followed by the owner/repo path.

opensrc path bitbucket:owner/repo

Use opensrc path <package> in a subshell to pass the local source code path to search tools like rg (ripgrep) or grep. This allows you to search for implementations rather than just type definitions.

rg "parse" $(opensrc path zod)

To resolve repositories from GitLab, use the gitlab: prefix followed by the owner/repo path.

opensrc path gitlab:owner/repo