OpenCodePilotA full graphical client for the OpenCode coding agent, inside VS Code and Cursor. OpenCode remains the agent and execution engine — models, tools, permissions, file operations. OpenCodePilot becomes its IDE interface: streaming chat, live tool activity, permission approvals, diff review, session management, dynamic model selection, and first-class Persian/RTL support.
Highlights
Prerequisites
InstallFrom source (development)
See INSTALL.md for detailed local-install instructions and PUBLISHING.md for Marketplace release steps. Getting started
Keybindings
All commands are also available under the Composer tips
Settings (
|
| Setting | Default | Purpose |
|---|---|---|
server.url |
(empty) | Connect to an existing server instead of auto-discovery |
server.executablePath |
opencode |
CLI binary used when starting a server |
server.port |
4096 |
Preferred port for auto-started servers |
server.autoStart |
true |
Start a server when none is reachable |
server.autoConnect |
true |
Connect when the sidebar opens |
ui.defaultAgent |
(empty) | Agent used for new prompts (e.g. build, plan) |
ui.direction |
auto |
Force UI text direction |
ui.notifications |
true |
Notify when long tasks finish outside the sidebar |
composer.sendOnEnter |
true |
Enter sends. When off, Enter inserts a newline and Ctrl/Cmd+Enter sends |
rules.autoInject |
true |
Attach applicable directory-scoped rules to prompts |
debug |
false |
Verbose logging to the Output channel |
OpenCode itself stays the source of truth for providers, keys, agents and permissions — configure those via opencode.json / opencode auth login.
How it connects
┌─────────────────────────── VS Code / Cursor ───────────────────────────┐
│ Sidebar Webview (Vue) ⇄ Extension Host (controller) │
│ │ typed intents / updates │
│ ▼ │
│ official @opencode-ai/sdk │
│ HTTP + SSE events │
└────────────────────────────┬───────────────────────────────────────────┘
▼
opencode serve (spawned or existing)
agent · tools · permissions · providers · storage
The extension never re-implements agent behavior. See ARCHITECTURE.md.
Development
npm install
npm run watch # rebuild extension + webview on change
# press F5 in VS Code → Extension Development Host
npm test # vitest unit suites
npm run smoke # end-to-end check against a real `opencode serve`
npm run typecheck && npm run lint
Documentation
- Architecture — components, event flow, security model
- INSTALL.md — run/package/install locally in VS Code and Cursor
- PUBLISHING.md — prepare and publish to the VS Code Marketplace
- CHANGELOG.md
Known limitations
- One OpenCode server serves one directory; multi-root workspaces use the first folder.
- Real-time terminal mirroring of executed commands is on the roadmap (OpenCode exposes PTY endpoints).