diff --git a/README.md b/README.md index 96d76e97..91755872 100644 --- a/README.md +++ b/README.md @@ -30,21 +30,24 @@ ## Highlights -- **Use it from anywhere** — Cloudflare tunnel with QR code onboarding. Scan, connect, code from your couch. -- **Branchable chat timeline** — Undo, redo, fork from any turn. Explore different approaches without losing your place. -- **GitHub-native workflows** — Start sessions from issues and PRs with context already attached. Review checks, merge — all in-app. -- **Project Actions** — Run dev servers, configure SSH port forwarding, open remote URLs locally. Your project commands, one click away. -- **Connect to remote machines** — Desktop app connects to remote OpenChamber instances over SSH, with dedicated lifecycle and UX flows. +- **Use it from anywhere** - Cloudflare tunnel with QR code onboarding. Scan, connect, code from your couch. +- **Branchable chat timeline** - Undo, redo, fork from any turn. Explore different approaches without losing your place. +- **GitHub-native workflows** - Start sessions from issues and PRs with context already attached. Review checks, merge - all in-app. +- **Project Actions** - Run dev servers, configure SSH port forwarding, open remote URLs locally. Your project commands, one click away. +- **Connect to remote machines** - Desktop app connects to remote OpenChamber instances over SSH, with dedicated lifecycle and UX flows. ## Quick Start > **Prerequisite:** [OpenCode CLI](https://opencode.ai) installed. -**Desktop (macOS)** — Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). +### **Desktop (macOS)** +Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). -**VS Code** — Install from [Marketplace](https://marketplace.visualstudio.com/items?itemName=fedaykindev.openchamber) or search "OpenChamber" in Extensions. +### **VS Code** +Install from [Marketplace](https://marketplace.visualstudio.com/items?itemName=fedaykindev.openchamber) or search "OpenChamber" in Extensions. -**CLI (Web + PWA)** — requires Node.js 20+ +### **CLI (Web + PWA)** +_requires Node.js 20+_ ```bash curl -fsSL https://raw.githubusercontent.com/btriapitsyn/openchamber/main/scripts/install.sh | bash @@ -132,7 +135,7 @@ For reliable long-lived access with a custom hostname from your Cloudflare accou - Multi-agent runs from one prompt with isolated worktrees for safe side-by-side comparisons - Voice mode with speech input and read-aloud responses for hands-free workflows - Plan/Build mode with a dedicated plan view for drafting and iterating steps -- Inline comment drafts on diffs, files, and plans — send feedback back to the agent +- Inline comment drafts on diffs, files, and plans - send feedback back to the agent - Shell mode via leading `!` with inline output - Share messages as images - Mermaid diagrams render inline with copy/download actions @@ -158,7 +161,7 @@ For reliable long-lived access with a custom hostname from your Cloudflare accou - Workspace file browser with inline editing, syntax highlighting, and markdown preview - Beautiful diff viewer with stacked/inline modes, lazy loading for large changesets - Integrated terminal with per-directory sessions, tabbed interface, and stable heavy-output performance -- Clickable file paths in messages — jump to exact line locations +- Clickable file paths in messages - jump to exact line locations - File-type icons across all views for faster visual scanning @@ -201,7 +204,7 @@ For reliable long-lived access with a custom hostname from your Cloudflare accou Customization - 18+ built-in themes with light/dark variants -- Custom themes via JSON files in `~/.config/openchamber/themes/` — hot reload, no restart +- Custom themes via JSON files in `~/.config/openchamber/themes/` - hot reload, no restart - Configurable keyboard shortcuts for chat, panels, and services - Font size, spacing, corner radius, and layout controls - Customizable project icons with upload and automatic favicon discovery @@ -230,7 +233,7 @@ Active development. Here's what's being worked on or planned: - Windows and Linux desktop apps - Mobile app with remote instance and laptop connectivity - More built-in tunneling options -- Kanban board for multi-agent management — keeping the human in the loop and in control +- Kanban board for multi-agent management - keeping the human in the loop and in control - Custom OpenCode plugins/tools built-in catalog - Linear integration - Built-in browser for running dev apps with agent integration @@ -241,13 +244,13 @@ Independent project, not affiliated with the OpenCode team. **Special thanks to:** -- [OpenCode](https://opencode.ai) — For the excellent API and extensible architecture. -- [Flexoki](https://github.com/kepano/flexoki) — Beautiful color scheme by [Steph Ango](https://stephango.com/flexoki). -- [Pierre](https://pierrejs-docs.vercel.app/) — Fast, beautiful diff viewer with syntax highlighting. -- [Tauri](https://github.com/tauri-apps/tauri) — Desktop application framework. -- [Ghostty-web](https://github.com/coder/ghostty-web) — Great implementation of a Ghostty web renderer. -- [David Hill](https://x.com/iamdavidhill) — Who inspired me to release this without [overthinking](https://x.com/iamdavidhill/status/1993648326450020746). -- [My wife](https://github.com/yulia-ivashko), who — with zero AI background — sat down with the app for the first time and built the firework celebration that plays on every successful push. +- [OpenCode](https://opencode.ai) - For the excellent API and extensible architecture. +- [Flexoki](https://github.com/kepano/flexoki) - Beautiful color scheme by [Steph Ango](https://stephango.com/flexoki). +- [Pierre](https://pierrejs-docs.vercel.app/) - Fast, beautiful diff viewer with syntax highlighting. +- [Tauri](https://github.com/tauri-apps/tauri) - Desktop application framework. +- [Ghostty-web](https://github.com/coder/ghostty-web) - Great implementation of a Ghostty web renderer. +- [David Hill](https://x.com/iamdavidhill) - Who inspired me to release this without [overthinking](https://x.com/iamdavidhill/status/1993648326450020746). +- [My wife](https://github.com/yulia-ivashko), who - with zero AI background - sat down with the app for the first time and built the firework celebration that plays on every successful push. - Every contributor who shaped this project with their PRs, ideas, and attention to detail. ## Contributing diff --git a/packages/desktop/README.md b/packages/desktop/README.md index d95f8cf9..626809fa 100644 --- a/packages/desktop/README.md +++ b/packages/desktop/README.md @@ -4,7 +4,7 @@ [![GitHub release](https://img.shields.io/github/v/release/btriapitsyn/openchamber?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiIgZmlsbD0iI2YxZWNlYyIgdmlld0JveD0iMCAwIDI1NiAyNTYiPjxwYXRoIGQ9Ik0xMjgsMTI5LjA5VjIzMmE4LDgsMCwwLDEtMy44NC0xbC04OC00OC4xOGE4LDgsMCwwLDEtNC4xNi03VjgwLjE4YTgsOCwwLDAsMSwuNy0zLjI1WiIgb3BhY2l0eT0iMC4yIj48L3BhdGg%2BPHBhdGggZD0iTTIyMy42OCw2Ni4xNSwxMzUuNjgsMThhMTUuODgsMTUuODgsMCwwLDAtMTUuMzYsMGwtODgsNDguMTdhMTYsMTYsMCwwLDAtOC4zMiwxNHY5NS42NGExNiwxNiwwLDAsMCw4LjMyLDE0bDg4LDQ4LjE3YTE1Ljg4LDE1Ljg4LDAsMCwwLDE1LjM2LDBsODgtNDguMTdhMTYsMTYsMCwwLDAsOC4zMi0xNFY4MC4xOEExNiwxNiwwLDAsMCwyMjMuNjgsNjYuMTVaTTEyOCwzMmw4MC4zNCw0NC0yOS43NywxNi4zLTgwLjM1LTQ0Wk0xMjgsMTIwLDQ3LjY2LDc2bDMzLjktMTguNTYsODAuMzQsNDRaTTQwLDkwbDgwLDQzLjc4djg1Ljc5TDQwLDE3NS44MlptMTc2LDg1Ljc4aDBsLTgwLDQzLjc5VjEzMy44MmwzMi0xNy41MVYxNTJhOCw4LDAsMCwwLDE2LDBWMTA3LjU1TDIxNiw5MHY4NS43N1oiPjwvcGF0aD48L3N2Zz4%3D&logoColor=FFFCF0&labelColor=100F0F&color=205EA6)](https://github.com/btriapitsyn/openchamber/releases/latest) [![Discord](https://img.shields.io/badge/Discord-join.svg?style=flat&labelColor=100F0F&color=8B7EC8&logo=discord&logoColor=FFFCF0)](https://discord.gg/ZYRSdnwwKA) -A native macOS app for [OpenCode](https://opencode.ai). Feels like home — multiple windows, SSH remotes, project actions, and everything running locally. +A native macOS app for [OpenCode](https://opencode.ai). Feels like home - multiple windows, SSH remotes, project actions, and everything running locally. Full project overview, screenshots, and all features: [github.com/btriapitsyn/openchamber](https://github.com/btriapitsyn/openchamber) @@ -16,12 +16,12 @@ Download from [Releases](https://github.com/btriapitsyn/openchamber/releases). A ## What makes the desktop app special -- **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 +- **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 Plus everything from the shared OpenChamber UI: branchable timeline, Git sidebar, terminal, voice mode, and more. diff --git a/packages/web/README.md b/packages/web/README.md index df8749db..7c91993f 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -91,11 +91,11 @@ 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 +- **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.