Where shared code shows up: a read-only browser viewer, the landing page and the documentation.
Website · Documentation · Brand · Issues
Viewers open a link and get the shared folder in their browser: a file tree, search, syntax-highlighted code, checkpoints and diffs, all following along live as the owner saves. Nothing to install. The same Next.js app serves the landing page and the documentation, built with React, TypeScript, Fumadocs, Zustand and Zod.
You need Node.js 22 or newer and pnpm.
pnpm install
pnpm devThe site runs at http://localhost:3000. API requests are proxied to the server at http://localhost:8080; set BIGA_SERVER_URL to point somewhere else. With both running, biga start from the CLI broadcasts to your local copy with no extra configuration.
| Path | What lives there |
|---|---|
apps/web |
The Next.js app: landing page, viewer and docs (content/docs) |
apps/cli |
The deprecated @zenshilabs/spire npm package, which points users to the Go CLI |
packages/stores |
Zustand stores for the viewer |
packages/types |
Zod schemas and types for the API, sessions and events |
packages/eslint-config |
ESLint configuration |
packages/typescript-config |
TypeScript configuration |
| Command | Purpose |
|---|---|
pnpm dev |
Start the development server |
pnpm build |
Build for production |
pnpm check-types |
Check TypeScript types |
pnpm lint |
Run ESLint |
pnpm format |
Format with Prettier |
The documentation source is in apps/web/content/docs. Fixes to it are welcome here.
| Repository | What it is |
|---|---|
| cli | The biga command. Watches a folder and streams every save. |
| server | The Go API. Stores sessions and streams updates to viewers. |
| website | The site, the live viewer and the documentation. |
| docker | Self-hosting: the whole stack with Docker Compose. |
Bug reports, focused fixes and pull requests are welcome. Read the contributing guide before you start, and report vulnerabilities privately as described in the security policy, not in a public issue.
biga is MIT licensed.
biga · Made for people who teach, pair and build in public.