BuzzbeeSCD/openchamber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): reorganize development instructions and enhance README clarity

Browse Source
This commit is contained in:
Bohdan Triapitsyn
2025-12-21 16:21:10 +02:00
parent 7b1d0c7791
commit 8a07b5c121
5 changed files with 75 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+13 -3
View File
@@ -1,13 +1,23 @@
# Contributing to OpenChamber # Contributing to OpenChamber
## Quick Start ## Development
```bash ```bash
git clone https://github.com/btriapitsyn/openchamber.git git clone https://github.com/btriapitsyn/openchamber.git
cd openchamber cd openchamber
pnpm install pnpm install
pnpm run dev:web:full # Web development
pnpm run desktop:dev # Desktop development (Tauri) # Web development
pnpm run dev:web:full
# Desktop app (Tauri)
pnpm desktop:dev
# VS Code extension
pnpm vscode:build && code --extensionDevelopmentPath="$(pwd)/packages/vscode"
# Production build
pnpm run build
``` ```
## Before Submitting ## Before Submitting
README.md
-20
View File
@@ -102,26 +102,6 @@ Download from [Releases](https://github.com/btriapitsyn/openchamber/releases).
- [OpenCode CLI](https://opencode.ai) installed - [OpenCode CLI](https://opencode.ai) installed
- Node.js 20+ (for web version) - Node.js 20+ (for web version)
## Development
```bash
git clone https://github.com/btriapitsyn/openchamber.git
cd openchamber
pnpm install
# Web development
pnpm run dev:web:full
# Desktop app (Tauri)
pnpm desktop:dev
# VS Code extension
pnpm vscode:build && code --extensionDevelopmentPath="$(pwd)/packages/vscode"
# Production build
pnpm run build
```
See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
## Tech Stack ## Tech Stack
packages/desktop/README.md
+21 -5
View File
@@ -2,6 +2,10 @@
Desktop application for the [OpenCode](https://opencode.ai) AI coding agent. Built with Tauri. Desktop application for the [OpenCode](https://opencode.ai) AI coding agent. Built with Tauri.
For the full project overview and screenshots, see the main repo:
https://github.com/btriapitsyn/openchamber
## Installation ## Installation
Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). Download from [Releases](https://github.com/btriapitsyn/openchamber/releases).
@@ -10,17 +14,29 @@ Currently available for macOS (Apple Silicon).
## Prerequisites ## Prerequisites
- [OpenCode CLI](https://opencode.ai) installed - [OpenCode CLI](https://opencode.ai) installed (`opencode`)
- OpenCode server running (`opencode serve`)
## Features ## Features
- Native macOS app with auto-updates ### Core UI
- Integrated terminal - Integrated terminal
- Git operations with identity management and AI commit message generation - Git operations with identity management and AI commit message generation
- Beautiful themes (Flexoki Light/Dark)
- Rich permission cards with syntax-highlighted operation previews
- Smart tool visualization (inline diffs, file trees, results highlighting) - Smart tool visualization (inline diffs, file trees, results highlighting)
- Per-agent permission mode control - Rich permission cards with syntax-highlighted operation previews
- Per-agent permission modes (ask/allow/full) per session
- Branchable conversations: start a new session from any assistant response
- Task tracker UI with live progress and tool summaries
- Model selection UX: favorites, recents, and configurable tool output density
- UI scaling controls (font size and spacing)
- Session auto-cleanup with configurable retention
- Memory optimizations with LRU eviction
### Desktop (macOS)
- Native macOS menu bar integration with app actions
- First-launch directory picker to minimize permission prompts
## Development ## Development
packages/vscode/README.md
+18 -3
View File
@@ -1,16 +1,31 @@
# OpenChamber VS Code Extension # OpenChamber VS Code Extension
AI coding assistant for VS Code powered by the OpenCode API. Embeds the OpenChamber chat interface in VS Code's activity bar. OpenChamber inside VS Code: embeds the OpenChamber chat UI in the activity bar and connects it to the [OpenCode](https://opencode.ai) API.
![VS Code Extension](https://github.com/btriapitsyn/openchamber/raw/HEAD/packages/vscode/extension.jpg) ![VS Code Extension](https://github.com/btriapitsyn/openchamber/raw/HEAD/packages/vscode/extension.jpg)
- Project overview + screenshots: https://github.com/btriapitsyn/openchamber
## Features ## Features
### OpenChamber UI
- Smart tool visualization (inline diffs, file trees, results highlighting)
- Rich permission cards with syntax-highlighted operation previews
- Per-agent permission modes (ask/allow/full) per session
- Branchable conversations: start a new session from any assistant response
- Task tracker UI with live progress and tool summaries
- Model selection UX (favorites, recents, and configurable tool output density)
- UI scaling controls (font size and spacing)
### VS Code Integration
- Chat UI in activity bar - Chat UI in activity bar
- Session management with history - Session management with history
- File attachments via native VS Code file picker (10MB limit) - File attachments via native VS Code file picker (10MB limit)
- Auto-start `opencode serve` if not running - Click-to-open files from tool output
- Workspace-isolated opencode instances (different workspaces get unique opencode instances) - Auto-start `opencode` instance if not running
- Workspace-isolated OpenCode instances (different workspaces get unique instances)
- Adapts to VS Code's light/dark/high-contrast themes - Adapts to VS Code's light/dark/high-contrast themes
## Commands ## Commands
packages/web/README.md
+23 -6
View File
@@ -1,6 +1,10 @@
# @openchamber/web # @openchamber/web
Web interface for the [OpenCode](https://opencode.ai) AI coding agent. 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 ## Installation
@@ -25,18 +29,31 @@ openchamber update # Update to latest version
## Prerequisites ## Prerequisites
- [OpenCode CLI](https://opencode.ai) installed and running (`opencode serve`) - [OpenCode CLI](https://opencode.ai) installed (`opencode`)
- Node.js 20+ - Node.js 20+
## Features ## Features
### Core UI
- Integrated terminal - Integrated terminal
- Git operations with identity management and AI commit message generation - Git operations with identity management and AI commit message generation
- Beautiful themes (Flexoki Light/Dark)
- Mobile-optimized with edge-swipe gestures
- Rich permission cards with syntax-highlighted operation previews
- Smart tool visualization (inline diffs, file trees, results highlighting) - Smart tool visualization (inline diffs, file trees, results highlighting)
- Per-agent permission mode control - Rich permission cards with syntax-highlighted operation previews
- Per-agent permission modes (ask/allow/full) per session
- Branchable conversations: start a new session from any assistant response
- Task tracker UI with live progress and tool summaries
- Model selection UX: favorites, recents, and configurable tool output density
- UI scaling controls (font size and spacing)
- Session auto-cleanup with configurable retention
- Memory optimizations with LRU eviction
### Web / PWA
- Mobile-first UI with gestures and optimized terminal controls
- Remote access from any device via browser (works alongside the OpenCode TUI)
- Self-serve updates (`openchamber update`) without reinstalling
- Update + restart keeps previous server settings (port/password)
## License ## License