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
+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
|
||||
|
||||
Reference in New Issue
Block a user