Files

T

Bohdan Triapitsyn f6e0dafeb5 docs: rewrite READMEs with progressive disclosure, add SECURITY.md and roadmap

Main README restructured: collapsable features, quick start with secure defaults, Why a GUI section, roadmap
Package READMEs (web/desktop/vscode) rewritten with runtime-specific focus; VSCode includes full commands and settings
Added SECURITY.md, non-dev contributing guide, and updated CONTRIBUTING.md with dev scripts and ports

2026-03-05 03:07:26 +02:00

6.2 KiB

Raw Blame History

@openchamber/web

Run OpenCode in your browser. Install the CLI, open localhost:3000, done. Works on desktop browsers, tablets, and phones as a PWA.

Full project overview, screenshots, and all features: github.com/btriapitsyn/openchamber

Install

curl -fsSL https://raw.githubusercontent.com/btriapitsyn/openchamber/main/scripts/install.sh | bash

Or install manually: bun add -g @openchamber/web (or npm, pnpm, yarn).

Prerequisites: OpenCode CLI installed, Node.js 20+.

Usage

openchamber                    # Start on port 3000
openchamber --port 8080        # Custom port
openchamber --ui-password secret   # Password-protect
openchamber stop               # Stop server
openchamber update             # Update to latest

Remote access & tunnels

openchamber --try-cf-tunnel                          # Cloudflare Quick Tunnel
openchamber --try-cf-tunnel --tunnel-qr              # + QR code for mobile
openchamber --try-cf-tunnel --tunnel-password-url     # + password in URL

Named Tunnel mode is configured in-app at Settings > OpenChamber > Tunnel. Requires cloudflared.

Connect to external OpenCode server

OPENCODE_PORT=4096 OPENCODE_SKIP_START=true openchamber
OPENCODE_HOST=https://myhost:4096 OPENCODE_SKIP_START=true openchamber

Variable	Description
`OPENCODE_HOST`	Full base URL of external server (overrides `OPENCODE_PORT`)
`OPENCODE_PORT`	Port of external server
`OPENCODE_SKIP_START`	Skip starting embedded OpenCode server

Docker

docker compose up -d    # Available at http://localhost:3000

Optional env vars:

environment:
  UI_PASSWORD: your_secure_password
  CF_TUNNEL: "true"   # Options: true, qr, password

Data directory: mount data/ for persistent storage. Ensure permissions:

mkdir -p data/openchamber data/opencode/share data/opencode/config data/ssh
chown -R 1000:1000 data/

Background & daemon mode

openchamber --daemon    # Run in background
openchamber stop        # Stop background server

What makes the web version special

Remote access — Cloudflare tunnel with QR onboarding. Scan from your phone, start coding.
Mobile-first PWA — optimized chat controls, keyboard-safe layouts, drag-to-reorder projects
Background notifications — know when your agent finishes, even from another tab
Self-update — update and restart from the UI, server settings stay intact
Cross-tab tracking — session activity stays in sync across browser tabs

Plus everything from the shared OpenChamber UI: branchable timeline, Git sidebar, terminal, voice mode, and more.

License

MIT

6.2 KiB Raw Blame History