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
This commit is contained in:
Bohdan Triapitsyn
+18
-33
@@ -1,49 +1,32 @@
|
||||
# <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/desktop
|
||||
# <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 Desktop
|
||||
|
||||
[](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)
|
||||
|
||||
Desktop application for the [OpenCode](https://opencode.ai) AI coding agent. Built with Tauri.
|
||||
A native macOS app for [OpenCode](https://opencode.ai). Feels like home — multiple windows, SSH remotes, project actions, and everything running locally.
|
||||
|
||||
For the full project overview and screenshots, see the main repo:
|
||||
Full project overview, screenshots, and all features: [github.com/btriapitsyn/openchamber](https://github.com/btriapitsyn/openchamber)
|
||||
|
||||
https://github.com/btriapitsyn/openchamber
|
||||
## Install
|
||||
|
||||
## Installation
|
||||
Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). Available for macOS (Apple Silicon and Intel).
|
||||
|
||||
Download from [Releases](https://github.com/btriapitsyn/openchamber/releases).
|
||||
> **Prerequisite:** [OpenCode CLI](https://opencode.ai) installed.
|
||||
|
||||
Currently available for macOS (Apple Silicon).
|
||||
## What makes the desktop app special
|
||||
|
||||
## Prerequisites
|
||||
- **Remote instances over SSH** — connect to remote OpenChamber servers with dedicated lifecycle and UX flows
|
||||
- **Project Actions** — run dev servers, configure SSH port forwarding, open remote URLs locally
|
||||
- **Multi-window** — work on several projects in parallel, each in its own window
|
||||
- **"Open In" shortcuts** — open workspace in Finder, Terminal, or your editor of choice
|
||||
- **Local + remote switching** — jump between local and remote OpenChamber instances
|
||||
- **Native macOS integration** — menus, deep-links, auto-update, and polished window management
|
||||
|
||||
- [OpenCode CLI](https://opencode.ai) installed (`opencode`)
|
||||
Plus everything from the shared OpenChamber UI: branchable timeline, Git sidebar, terminal, voice mode, and more.
|
||||
|
||||
## 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
|
||||
|
||||
### Desktop (macOS)
|
||||
|
||||
- Native macOS menu integration with polished app actions and deep-link handling
|
||||
- Multi-window support for parallel project/session workflows
|
||||
- "Open In" shortcuts for Finder, Terminal, and your preferred editor
|
||||
- Fast switching between local and remote instances
|
||||
- Workspace-first startup flow with directory picker and steadier window restore behavior
|
||||
|
||||
## Development
|
||||
<details>
|
||||
<summary>Development</summary>
|
||||
|
||||
```bash
|
||||
git clone https://github.com/btriapitsyn/openchamber.git
|
||||
@@ -52,6 +35,8 @@ bun install
|
||||
bun run desktop:dev
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
+42
-33
@@ -1,66 +1,75 @@
|
||||
# OpenChamber VS Code Extension
|
||||
|
||||
[](https://github.com/btriapitsyn/openchamber/stargazers)
|
||||
[](https://github.com/btriapitsyn/openchamber/network/members)
|
||||
[](https://github.com/btriapitsyn/openchamber/releases/latest)
|
||||
[](https://github.com/btriapitsyn/openchamber/releases/latest)
|
||||
[](https://discord.gg/ZYRSdnwwKA)
|
||||
[](https://ko-fi.com/G2G41SAWNS)
|
||||
|
||||
OpenChamber inside VS Code: embeds the OpenChamber chat UI in the activity bar and connects it to the [OpenCode](https://opencode.ai) API.
|
||||
[OpenCode](https://opencode.ai) AI coding agent, right inside your editor. No tab-switching, no context loss.
|
||||
|
||||
|
||||
|
||||
- Project overview + screenshots: https://github.com/btriapitsyn/openchamber
|
||||
**Like the extension? There's also a [desktop app and web version](https://github.com/btriapitsyn/openchamber) with even more features.**
|
||||
|
||||
## Features
|
||||
## What you get
|
||||
|
||||
### OpenChamber UI
|
||||
- **Chat beside your code** — responsive layout that adapts to narrow and wide panels
|
||||
- **Agent Manager** — run the same prompt across multiple models in parallel, compare results side by side
|
||||
- **Right-click actions** — add context, explain selections, and improve code in-place
|
||||
- **Click-to-open** — file paths in tool output open directly in your editor; edit-style results land in a focused diff view
|
||||
- **Session editor panel** — keep chat sessions open alongside files
|
||||
- **Theme-aware** — adapts to your VS Code light, dark, and high-contrast themes
|
||||
|
||||
- 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
|
||||
- Live streaming updates with smoother auto-follow for long assistant responses
|
||||
- Mermaid diagrams rendered inline in chat with quick copy/download actions
|
||||
- Context visibility tools (token/cost breakdowns and raw message inspection)
|
||||
- Model selection UX (favorites, recents, and configurable tool output density)
|
||||
|
||||
### VS Code Integration
|
||||
|
||||
- Chat UI embedded in VS Code with responsive layouts for narrow/wide panels
|
||||
- Agent Manager for parallel multi-model runs from one prompt
|
||||
- Session editor panel to keep chats open beside your code
|
||||
- Right-click actions to add context, explain selections, and improve code in-place
|
||||
- Click-to-open files and native file attachments from within the extension
|
||||
- Managed runtime startup with hardened health checks and secure auth forwarding
|
||||
- Adapts to VS Code light/dark/high-contrast themes
|
||||
Plus everything from the shared OpenChamber UI: branchable timeline, smart tool UIs, voice mode, Git workflows, and more.
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `OpenChamber: Focus on Chat View` | Focus chat panel |
|
||||
| `OpenChamber: Restart API Connection` | Restart OpenCode API process |
|
||||
| `OpenChamber: Show OpenCode Status` | Provide debug info useful for development or bug report |
|
||||
| `OpenChamber: Focus Chat` | Focus the chat panel |
|
||||
| `OpenChamber: New Session` | Start a new chat session |
|
||||
| `OpenChamber: Open Sidebar` | Open the OpenChamber sidebar |
|
||||
| `OpenChamber: Open Agent Manager` | Launch parallel multi-model runs |
|
||||
| `OpenChamber: Open Session in Editor` | Open current or new session in an editor tab |
|
||||
| `OpenChamber: Settings` | Open extension settings |
|
||||
| `OpenChamber: Restart API Connection` | Restart the OpenCode API process |
|
||||
| `OpenChamber: Show OpenCode Status` | Debug info for development or bug reports |
|
||||
|
||||
### Right-click menu
|
||||
|
||||
Select code in the editor, right-click, and find the **OpenChamber** submenu:
|
||||
|
||||
| Action | Description |
|
||||
|--------|-------------|
|
||||
| Add to Context | Attach selection to your next prompt |
|
||||
| Explain | Ask the agent to explain the selected code |
|
||||
| Improve Code | Ask the agent to improve the selection in-place |
|
||||
|
||||
## Configuration
|
||||
|
||||
| Setting | Default | Description |
|
||||
|---------|---------|-------------|
|
||||
| `openchamber.apiUrl` | `http://localhost:47339` | OpenCode API server URL. Not required by default. Spawns its own process when not set. |
|
||||
| `openchamber.apiUrl` | _(empty)_ | URL of an external OpenCode API server. Leave empty to auto-start a local instance. |
|
||||
| `openchamber.opencodeBinary` | _(empty)_ | Absolute path to the `opencode` CLI binary. Useful when PATH lookup fails. Requires window reload to apply. |
|
||||
|
||||
## Requirements
|
||||
|
||||
- OpenCode CLI installed and available in PATH (or set via `OPENCODE_BINARY` env var)
|
||||
- VS Code 1.85.0+
|
||||
- [OpenCode CLI](https://opencode.ai) installed and available in PATH (or set `OPENCODE_BINARY` env var)
|
||||
- VS Code 1.85+
|
||||
|
||||
## Development
|
||||
<details>
|
||||
<summary>Development</summary>
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun run --cwd packages/vscode build # build extension + webview
|
||||
bun run --cwd packages/vscode build
|
||||
cd packages/vscode && bunx vsce package --no-dependencies
|
||||
```
|
||||
|
||||
## Local Install
|
||||
Install locally: `code --install-extension packages/vscode/openchamber-*.vsix`
|
||||
|
||||
- After packaging: `code --install-extension packages/vscode/openchamber-*.vsix`
|
||||
- Or in VS Code: Extensions panel → "Install from VSIX…" and select the file
|
||||
</details>
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
+73
-46
@@ -1,76 +1,103 @@
|
||||
# <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.
|
||||
Run [OpenCode](https://opencode.ai) in your browser. Install the CLI, open `localhost:3000`, done. Works on desktop browsers, tablets, and phones as a PWA.
|
||||
|
||||
This package installs the `openchamber` CLI that runs a local web server. For the full project overview and screenshots, see the main repo:
|
||||
Full project overview, screenshots, and all features: [github.com/btriapitsyn/openchamber](https://github.com/btriapitsyn/openchamber)
|
||||
|
||||
https://github.com/btriapitsyn/openchamber
|
||||
|
||||
## Installation
|
||||
## Install
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Or install manually: `bun add -g @openchamber/web` (or npm, pnpm, yarn).
|
||||
|
||||
> **Prerequisites:** [OpenCode CLI](https://opencode.ai) installed, Node.js 20+.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
openchamber # Start on port 3000
|
||||
openchamber --port 8080 # Custom port
|
||||
openchamber --daemon # Background mode
|
||||
openchamber --ui-password secret # Password-protect UI
|
||||
openchamber --try-cf-tunnel # Create a Cloudflare Quick Tunnel for remote access
|
||||
openchamber --try-cf-tunnel --tunnel-qr # Show QR code for easy mobile access
|
||||
openchamber --try-cf-tunnel --tunnel-password-url # Include password in URL for auto-login
|
||||
OPENCODE_PORT=4096 OPENCODE_SKIP_START=true openchamber # Connect to external OpenCode server
|
||||
OPENCODE_HOST=https://myhost:4096 OPENCODE_SKIP_START=true openchamber # Connect via custom host/HTTPS
|
||||
openchamber stop # Stop server
|
||||
openchamber update # Update to latest version
|
||||
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
|
||||
```
|
||||
|
||||
Named Tunnel mode is configured in-app (Settings -> OpenChamber -> Tunnel). The CLI currently supports Quick Tunnel flags only. `--tunnel <config.yml>` is not supported yet.
|
||||
<details>
|
||||
<summary>Remote access & tunnels</summary>
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
- `OPENCODE_HOST` - Full base URL of external OpenCode server, e.g. `http://hostname:4096` or `https://hostname:4096` (overrides `OPENCODE_PORT`)
|
||||
- `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_HOST` or `OPENCODE_PORT` to connect to external instance)
|
||||
Named Tunnel mode is configured in-app at **Settings > OpenChamber > Tunnel**. Requires [cloudflared](https://github.com/cloudflare/cloudflared/releases).
|
||||
|
||||
## Prerequisites
|
||||
</details>
|
||||
|
||||
- [OpenCode CLI](https://opencode.ai) installed (`opencode`)
|
||||
- Node.js 20+
|
||||
<details>
|
||||
<summary>Connect to external OpenCode server</summary>
|
||||
|
||||
## Features
|
||||
```bash
|
||||
OPENCODE_PORT=4096 OPENCODE_SKIP_START=true openchamber
|
||||
OPENCODE_HOST=https://myhost:4096 OPENCODE_SKIP_START=true openchamber
|
||||
```
|
||||
|
||||
### Core UI
|
||||
| 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 |
|
||||
|
||||
- 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
|
||||
</details>
|
||||
|
||||
### Web / PWA
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
- Cloudflare tunnel access with two modes: Quick Tunnel (CLI) and Named Tunnel (in-app settings)
|
||||
- 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
|
||||
```bash
|
||||
docker compose up -d # Available at http://localhost:3000
|
||||
```
|
||||
|
||||
**Optional env vars:**
|
||||
```yaml
|
||||
environment:
|
||||
UI_PASSWORD: your_secure_password
|
||||
CF_TUNNEL: "true" # Options: true, qr, password
|
||||
```
|
||||
|
||||
**Data directory:** mount `data/` for persistent storage. Ensure permissions:
|
||||
```bash
|
||||
mkdir -p data/openchamber data/opencode/share data/opencode/config data/ssh
|
||||
chown -R 1000:1000 data/
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Background & daemon mode</summary>
|
||||
|
||||
```bash
|
||||
openchamber --daemon # Run in background
|
||||
openchamber stop # Stop background server
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user