71 lines
8.3 KiB
Markdown
71 lines
8.3 KiB
Markdown
# <picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/btriapitsyn/openchamber/raw/HEAD/docs/references/badges/openchamber-logo-dark.svg"><img src="https://github.com/btriapitsyn/openchamber/raw/HEAD/docs/references/badges/openchamber-logo-light.svg" width="32" height="32" align="absmiddle" /></picture> @openchamber/web
|
|
|
|
[](https://github.com/btriapitsyn/openchamber/stargazers)
|
|
[](https://github.com/btriapitsyn/openchamber/network/members)
|
|
[](https://github.com/btriapitsyn/openchamber/releases/latest)
|
|
[](https://opencode.ai)
|
|
[](https://zread.ai/btriapitsyn/openchamber)
|
|
[](https://discord.gg/ZYRSdnwwKA)
|
|
[](https://ko-fi.com/G2G41SAWNS)
|
|
|
|
Web/PWA interface for the [OpenCode](https://opencode.ai) AI coding agent.
|
|
|
|
This package installs the `openchamber` CLI that runs a local web server. For the full project overview and screenshots, see the main repo:
|
|
|
|
https://github.com/btriapitsyn/openchamber
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Quick install (auto-detects your package manager)
|
|
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
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
openchamber # Start on port 3000
|
|
openchamber --port 8080 # Custom port
|
|
openchamber --daemon # Background mode
|
|
openchamber --ui-password secret # Password-protect UI
|
|
OPENCODE_PORT=4096 OPENCODE_SKIP_START=true openchamber # Connect to external OpenCode server
|
|
openchamber stop # Stop server
|
|
openchamber update # Update to latest version
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
- `OPENCODE_PORT` - Port of external OpenCode server to connect to (instead of starting embedded server)
|
|
- `OPENCODE_SKIP_START` - Skip starting embedded OpenCode server (use with `OPENCODE_PORT` to connect to external instance)
|
|
|
|
## Prerequisites
|
|
|
|
- [OpenCode CLI](https://opencode.ai) installed (`opencode`)
|
|
- Node.js 20+
|
|
|
|
## Features
|
|
|
|
### Core UI
|
|
|
|
- Branchable chat timeline with `/undo`, `/redo`, and one-click forks from earlier turns
|
|
- Smart tool UIs for diffs, file operations, permissions, and long-running task progress
|
|
- Multi-agent runs from one prompt with isolated worktrees for safe comparisons
|
|
- Git workflows in-app: identities, commits, PR creation, checks, and merge actions
|
|
- Context visibility tools (token/cost breakdowns, raw message inspection, and activity summaries)
|
|
- Integrated terminal with per-directory sessions and stable performance on heavy output
|
|
|
|
### Web / PWA
|
|
|
|
- Cloudflare Quick Tunnel for instant remote access (`--try-cf-tunnel`)
|
|
- One-scan onboarding with tunnel QR + password URL helpers
|
|
- Mobile-first experience: optimized chat controls, keyboard-safe layouts, and attachment-friendly UI
|
|
- Background notifications plus reliable cross-tab session activity tracking
|
|
- Built-in self-update + restart flow that keeps your server settings intact
|
|
|
|
## License
|
|
|
|
MIT
|