opencode

README

⌬ OpenCode

⚠️ Early Development Notice: This project is in early development and is not yet ready for production use. Features may change, break, or be incomplete. Use at your own risk.

A powerful terminal-based AI assistant for developers, providing intelligent coding assistance directly in your terminal.

Overview

OpenCode is a Go-based CLI application that brings AI assistance to your terminal. It provides a TUI (Terminal User Interface) for interacting with various AI models to help with coding tasks, debugging, and more.

Features

• Interactive TUI: Built with Bubble Tea for a smooth terminal experience
• Multiple AI Providers: Support for OpenAI, Anthropic Claude, Google Gemini, AWS Bedrock, and Groq
• Session Management: Save and manage multiple conversation sessions
• Tool Integration: AI can execute commands, search files, and modify code
• Vim-like Editor: Integrated editor with text input capabilities
• Persistent Storage: SQLite database for storing conversations and sessions
• LSP Integration: Language Server Protocol support for code intelligence
• File Change Tracking: Track and visualize file changes during sessions
• External Editor Support: Open your preferred editor for composing messages

Installation

# Coming soon
go install github.com/opencode-ai/opencode@latest

Configuration

OpenCode looks for configuration in the following locations:

• $HOME/.opencode.json
• $XDG_CONFIG_HOME/opencode/.opencode.json
• ./.opencode.json (local directory)

Environment Variables

You can configure OpenCode using environment variables:

Environment Variable	Purpose
ANTHROPIC_API_KEY	For Claude models
OPENAI_API_KEY	For OpenAI models
GEMINI_API_KEY	For Google Gemini models
GROQ_API_KEY	For Groq models
AWS_ACCESS_KEY_ID	For AWS Bedrock (Claude)
AWS_SECRET_ACCESS_KEY	For AWS Bedrock (Claude)
AWS_REGION	For AWS Bedrock (Claude)

Configuration File Structure

{
  "data": {
    "directory": ".opencode"
  },
  "providers": {
    "openai": {
      "apiKey": "your-api-key",
      "disabled": false
    },
    "anthropic": {
      "apiKey": "your-api-key",
      "disabled": false
    }
  },
  "agents": {
    "coder": {
      "model": "claude-3.7-sonnet",
      "maxTokens": 5000
    },
    "task": {
      "model": "claude-3.7-sonnet",
      "maxTokens": 5000
    },
    "title": {
      "model": "claude-3.7-sonnet",
      "maxTokens": 80
    }
  },
  "mcpServers": {
    "example": {
      "type": "stdio",
      "command": "path/to/mcp-server",
      "env": [],
      "args": []
    }
  },
  "lsp": {
    "go": {
      "disabled": false,
      "command": "gopls"
    }
  },
  "debug": false,
  "debugLSP": false
}

Supported AI Models

OpenCode supports a variety of AI models from different providers:

OpenAI

• GPT-4.1 family (gpt-4.1, gpt-4.1-mini, gpt-4.1-nano)
• GPT-4.5 Preview
• GPT-4o family (gpt-4o, gpt-4o-mini)
• O1 family (o1, o1-pro, o1-mini)
• O3 family (o3, o3-mini)
• O4 Mini

Anthropic

• Claude 3.5 Sonnet
• Claude 3.5 Haiku
• Claude 3.7 Sonnet
• Claude 3 Haiku
• Claude 3 Opus

Google

• Gemini 2.5
• Gemini 2.5 Flash
• Gemini 2.0 Flash
• Gemini 2.0 Flash Lite

AWS Bedrock

• Claude 3.7 Sonnet

Usage

# Start OpenCode
opencode

# Start with debug logging
opencode -d

# Start with a specific working directory
opencode -c /path/to/project

Command-line Flags

Flag	Short	Description
--help	-h	Display help information
--debug	-d	Enable debug mode
--cwd	-c	Set current working directory

Keyboard Shortcuts

Global Shortcuts

Shortcut	Action
Ctrl+C	Quit application
Ctrl+?	Toggle help dialog
?	Toggle help dialog (when not in editing mode)
Ctrl+L	View logs
Ctrl+A	Switch session
Ctrl+K	Command dialog
Esc	Close current overlay/dialog or return to previous mode

Chat Page Shortcuts

Shortcut	Action
Ctrl+N	Create new session
Ctrl+X	Cancel current operation/generation
i	Focus editor (when not in writing mode)
Esc	Exit writing mode and focus messages

Editor Shortcuts

Shortcut	Action
Ctrl+S	Send message (when editor is focused)
Enter or Ctrl+S	Send message (when editor is not focused)
Ctrl+E	Open external editor
Esc	Blur editor and focus messages

Session Dialog Shortcuts

Shortcut	Action
↑ or k	Previous session
↓ or j	Next session
Enter	Select session
Esc	Close dialog

Permission Dialog Shortcuts

Shortcut	Action
← or left	Switch options left
→ or right or tab	Switch options right
Enter or space	Confirm selection
a	Allow permission
A	Allow permission for session
d	Deny permission

Logs Page Shortcuts

Shortcut	Action
Backspace or q	Return to chat page

AI Assistant Tools

OpenCode's AI assistant has access to various tools to help with coding tasks:

File and Code Tools

Tool	Description	Parameters
glob	Find files by pattern	pattern (required), path (optional)
grep	Search file contents	pattern (required), path (optional), include (optional), literal_text (optional)
ls	List directory contents	path (optional), ignore (optional array of patterns)
view	View file contents	file_path (required), offset (optional), limit (optional)
write	Write to files	file_path (required), content (required)
edit	Edit files	Various parameters for file editing
patch	Apply patches to files	file_path (required), diff (required)
diagnostics	Get diagnostics information	file_path (optional)

Other Tools

Tool	Description	Parameters
bash	Execute shell commands	command (required), timeout (optional)
fetch	Fetch data from URLs	url (required), format (required), timeout (optional)
sourcegraph	Search code across public repositories	query (required), count (optional), context_window (optional), timeout (optional)
agent	Run sub-tasks with the AI agent	prompt (required)

Architecture

OpenCode is built with a modular architecture:

• cmd: Command-line interface using Cobra
• internal/app: Core application services
• internal/config: Configuration management
• internal/db: Database operations and migrations
• internal/llm: LLM providers and tools integration
• internal/tui: Terminal UI components and layouts
• internal/logging: Logging infrastructure
• internal/message: Message handling
• internal/session: Session management
• internal/lsp: Language Server Protocol integration

MCP (Model Context Protocol)

OpenCode implements the Model Context Protocol (MCP) to extend its capabilities through external tools. MCP provides a standardized way for the AI assistant to interact with external services and tools.

MCP Features

• External Tool Integration: Connect to external tools and services via a standardized protocol
• Tool Discovery: Automatically discover available tools from MCP servers
• Multiple Connection Types:
  • Stdio: Communicate with tools via standard input/output
  • SSE: Communicate with tools via Server-Sent Events
• Security: Permission system for controlling access to MCP tools

Configuring MCP Servers

MCP servers are defined in the configuration file under the mcpServers section:

{
  "mcpServers": {
    "example": {
      "type": "stdio",
      "command": "path/to/mcp-server",
      "env": [],
      "args": []
    },
    "web-example": {
      "type": "sse",
      "url": "https://example.com/mcp",
      "headers": {
        "Authorization": "Bearer token"
      }
    }
  }
}

MCP Tool Usage

Once configured, MCP tools are automatically available to the AI assistant alongside built-in tools. They follow the same permission model as other tools, requiring user approval before execution.

LSP (Language Server Protocol)

OpenCode integrates with Language Server Protocol to provide code intelligence features across multiple programming languages.

LSP Features

• Multi-language Support: Connect to language servers for different programming languages
• Diagnostics: Receive error checking and linting information
• File Watching: Automatically notify language servers of file changes

Configuring LSP

Language servers are configured in the configuration file under the lsp section:

{
  "lsp": {
    "go": {
      "disabled": false,
      "command": "gopls"
    },
    "typescript": {
      "disabled": false,
      "command": "typescript-language-server",
      "args": ["--stdio"]
    }
  }
}

LSP Integration with AI

The AI assistant can access LSP features through the diagnostics tool, allowing it to:

• Check for errors in your code
• Suggest fixes based on diagnostics

While the LSP client implementation supports the full LSP protocol (including completions, hover, definition, etc.), currently only diagnostics are exposed to the AI assistant.

Development

Prerequisites

• Go 1.24.0 or higher

Building from Source

# Clone the repository
git clone https://github.com/opencode-ai/opencode.git
cd opencode

# Build
go build -o opencode

# Run
./opencode

Acknowledgments

OpenCode gratefully acknowledges the contributions and support from these key individuals:

• @isaacphi - For the mcp-language-server project which provided the foundation for our LSP client implementation
• @adamdottv - For the design direction and UI/UX architecture

Special thanks to the broader open source community whose tools and libraries have made this project possible.

License

OpenCode is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Here's how you can contribute:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please make sure to update tests as appropriate and follow the existing code style.