Pich logoPichdocs
Docs menu: Public GitHub reader

Architecture

Public GitHub reader

How Pich reads a public repository as text without running it.

loadPublicRepo() in src/lib/github.ts reads one public repository through the GitHub API and raw.githubusercontent.com, without a token.

Files read

  • package.json, package-lock.json
  • next.config.js|mjs|ts|cjs
  • middleware.ts|js and proxy.ts|js, at the root or in src/
  • pich.deploy.json
  • Presence only: yarn.lock, pnpm-lock.yaml, bun.lockb, bun.lock, and paths under app/, pages/, src/app/, src/pages/

Limits

  • Files over 5 MB are skipped.
  • Loaded repositories are cached for 5 minutes.
  • Branches with slashes and monorepo subfolders are supported through /tree/<ref>/<path> links.
  • A repository whose package.json does not depend on next is refused.

Boundary

Nothing is installed, built, or executed. The files are parsed as text.

Edit this page on GitHub