Skip to content
biga-shPublic

About

Share your local codebase through a live, read-only link. Watch files update in the browser as you work.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

biga

Share a folder from your terminal

The biga command watches a folder and streams every save to a live, read-only link.

CI status Latest release Go version MIT license

Website · Documentation · Releases · Issues


Run it in a project, send the link, keep working. Viewers browse the files, search, and step through checkpoints in their browser as you save. Nobody clones your repository or creates an account, and nobody can change your files.

Get started

Install

macOS, Linux and FreeBSD

curl -fsSL https://raw.githubusercontent.com/biga-sh/cli/main/install.sh | sh

Windows (PowerShell)

irm https://raw.githubusercontent.com/biga-sh/cli/main/install.ps1 | iex

With Go

go install github.com/biga-sh/cli/cmd/biga@latest

The install scripts check the download against the release's checksums, and against its Sigstore signature when cosign is installed. Set BIGA_VERSION to pin a version or BIGA_INSTALL_DIR to change where it goes (default ~/.local/bin). See installation for details.

Share a project

From the folder you want to share:

biga start

biga uploads the folder, prints a link and keeps streaming every saved change until you stop it. Press c to copy the link, o to open it and q to stop. Running biga start in the same folder later rejoins the same session, so a link you already shared keeps working.

Choose a server

By default the CLI talks to http://localhost:3000, a local copy of the website and server. To share with people outside your machine, point it at a hosted instance:

BIGA_API_URL=https://biga.example.com BIGA_ACCESS_KEY=bgk_… biga start

To run your own, see biga-sh/docker.

Commands

Command What it does
biga start [dir...] Broadcast a folder and stream every save
biga status [dir] Show the session for a folder, or a summary of all of them
biga list List known sessions and whether they are live
biga open [dir] Open a folder's session in the browser
biga stop [dir] Stop a folder's session, or every session with --all

Configuration

Variable Purpose
BIGA_API_URL Server to broadcast to. Same as --api-url. Default http://localhost:3000.
BIGA_ACCESS_KEY Access key, for servers that require one
BIGA_HOME Where local session state lives. Default ~/.biga.
BIGA_NO_UPDATE_CHECK Turn off the check for new releases

Timing settings and the full reference are in the CLI documentation and configuration.

Development

The CLI is a single Go module with no cgo. You need Go 1.26 or newer.

make test    # tests with the race detector
make lint    # golangci-lint
make build   # ./biga

CONTRIBUTING.md covers the project layout and what CI checks.

Documentation

Repositories

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.

Contributing

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.

License

biga is MIT licensed.


biga · Made for people who teach, pair and build in public.

About

Share your local codebase through a live, read-only link. Watch files update in the browser as you work.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages