OpenCodeRust

A Rust implementation of OpenCode

OpenCodeRust is the Rust implementation and evolution of OpenCode. It provides a full CLI/TUI/Server workflow for local AI coding agents, session management, tool invocation, MCP/LSP integration, and plugin extensions.

Current status

• Project name: OpenCodeRust
• Executable: opencode (kept for backward compatibility)

Feature overview

• Interaction modes: TUI (default), CLI single run, HTTP server, Web/ACP mode
• Sessions: Create, continue, fork sessions; import/export
• Tool system: Built-in read/write/edit, shell, patch, and related tools
• Model support: Multiple providers, agent mode switching
• Extensibility: Plugin bridge (including TS plugins), MCP, LSP
• Terminal: Improved layout, collapsible sidebar, syntax highlighting, path completion

Quick start

1. Requirements

• Rust stable
• Cargo
• Git (recommended)

2. Build

cargo build -p opencode-cli

3. Use this project's binary

To avoid running another OpenCode (e.g. npm/global) on your PATH when using OpenCodeRust, run from the repo root:

• ./target/debug/opencode after cargo build -p opencode-cli
• cargo run -p opencode-cli -- to always use this repo's version

4. Show help

./target/debug/opencode --help

or

cargo run -p opencode-cli -- --help

5. How to run

• Default: start TUI:

cargo run -p opencode-cli --

• Start TUI explicitly:

cargo run -p opencode-cli -- tui

• Single non-interactive run:

cargo run -p opencode-cli -- run "Check this repo for risks"

• Start HTTP server:

cargo run -p opencode-cli -- serve --port 3000 --hostname 127.0.0.1

CLI commands overview

From the repo root use ./target/debug/opencode or cargo run -p opencode-cli --. These commands match the current ./target/debug/opencode --help:

• tui – Start interactive terminal UI
• attach – Attach to a running server
• run – Run a single message
• serve – Start HTTP server
• web – Start headless server and open web UI
• acp – Start ACP server
• models – List available models
• session – Session management
• stats – Token/cost statistics
• db – Database tools
• config – Show configuration
• auth – Credential management
• agent – Agent management
• debug – Debugging and troubleshooting
• mcp – MCP management
• export / import – Export/import sessions
• github / pr – GitHub-related features
• upgrade / uninstall – Upgrade and uninstall
• generate – Generate OpenAPI spec
• version – Show version

Subcommand help:

./target/debug/opencode tui --help
./target/debug/opencode run --help
./target/debug/opencode serve --help
./target/debug/opencode session --help

Configuration

Configuration is merged from the following paths in priority order (searched upward):

• opencode.jsonc
• opencode.json
• .opencode/opencode.jsonc
• .opencode/opencode.json

Global config default path:

• Linux/macOS: ~/.config/opencode/opencode.jsonc (or .json)

See: docs/opencode-config.md

Repository structure

• crates/opencode-cli – CLI entrypoint (binary: opencode)
• crates/opencode-server – HTTP/SSE/WebSocket server
• crates/opencode-tui – Terminal UI
• crates/opencode-session – Sessions and messages
• crates/opencode-tool – Tool registration and execution
• crates/opencode-provider – Model provider adapters
• crates/opencode-plugin – Plugin system and subprocess bridge
• crates/opencode-mcp – MCP client and registration
• crates/opencode-lsp – LSP support
• crates/opencode-storage – SQLite storage

Development and validation

cargo fmt
cargo check
cargo clippy --workspace --all-targets

Minimal check (typical):

cargo check -p opencode-cli
cargo check -p opencode-tui

Documentation

• User guide: USER_GUIDE.md
• Docs index: docs/README.md
• CLI: docs/opencode-cli.md
• TUI: docs/opencode-tui.md
• Server: docs/opencode-server.md
• Tools: docs/opencode-tool.md
• Provider: docs/opencode-provider.md
• Config: docs/opencode-config.md

Notes

• The executable name remains opencode for backward compatibility. OpenCodeRust is the project name.