diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e14fcde9..78c80181 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,23 @@ # Contributing to OpenChamber -## Quick Start +## Development ```bash git clone https://github.com/btriapitsyn/openchamber.git cd openchamber 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 diff --git a/README.md b/README.md index 5edf21e8..2c0284f4 100644 --- a/README.md +++ b/README.md @@ -102,26 +102,6 @@ Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). - [OpenCode CLI](https://opencode.ai) installed - 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. ## Tech Stack diff --git a/packages/desktop/README.md b/packages/desktop/README.md index a6b3a533..426de5df 100644 --- a/packages/desktop/README.md +++ b/packages/desktop/README.md @@ -2,6 +2,10 @@ 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 Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). @@ -10,17 +14,29 @@ Currently available for macOS (Apple Silicon). ## Prerequisites -- [OpenCode CLI](https://opencode.ai) installed +- [OpenCode CLI](https://opencode.ai) installed (`opencode`) +- OpenCode server running (`opencode serve`) ## Features -- Native macOS app with auto-updates +### Core UI + - Integrated terminal - 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) -- 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 diff --git a/packages/vscode/README.md b/packages/vscode/README.md index c505e036..438d188d 100644 --- a/packages/vscode/README.md +++ b/packages/vscode/README.md @@ -1,16 +1,31 @@ # 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) +- Project overview + screenshots: https://github.com/btriapitsyn/openchamber + ## 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 - Session management with history - File attachments via native VS Code file picker (10MB limit) -- Auto-start `opencode serve` if not running -- Workspace-isolated opencode instances (different workspaces get unique opencode instances) +- Click-to-open files from tool output +- 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 ## Commands diff --git a/packages/web/README.md b/packages/web/README.md index 08241229..93bbaa1a 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -1,6 +1,10 @@ # @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 @@ -25,18 +29,31 @@ openchamber update # Update to latest version ## Prerequisites -- [OpenCode CLI](https://opencode.ai) installed and running (`opencode serve`) +- [OpenCode CLI](https://opencode.ai) installed (`opencode`) - Node.js 20+ ## Features +### Core UI + - Integrated terminal - 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) -- 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