LXer

Quick Install (Recommended)

Node.js

Homebrew (macOS/Linux)

Arch Linux

Windows

1. Connect a Provider

Run this command, select a provider, and follow the prompts to add your API key.

Recommended: Use OpenCode Zen for curated, verified models.

2. Initialize a Project

The /init command analyzes your project and creates an AGENTS.md file.

3. Start Coding!

Now you're ready to work with OpenCode. Ask questions, add features, or make changes.

Plan Mode vs Build Mode

OpenCode has two modes:

Toggle Mode

Basic Syntax

Use the @ key to fuzzy search for files in your project.

Examples

Images

Drag and drop images into the terminal to have OpenCode analyze them.

Leader Key Concept

To execute a shortcut like <leader>n (new session):

1. Press and hold Ctrl
2. Press x (leader)
3. Release both
4. Press n

Or: Press Ctrl+x then n

Session Controls

Message Navigation

Input / Editor

Model & Agent

UI Controls

Disabling Keybinds

Set a keybind to "none" in tui.json to disable it:

{
  "keybinds": {
    "session_compact": "none"
  }
}

Command File Location

• Global: ~/.config/opencode/commands/
• Project: .opencode/commands/

Creating a Command

Create a markdown file with frontmatter:

---
description: Run tests with coverage
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

Run the full test suite with coverage report and show any failures.
Focus on the failing tests and suggest fixes.

File: test.md → Command: /test

Arguments

Pass arguments using placeholders:

Example command component.md:

---
description: Create a new component
---

Create a new React component named $ARGUMENTS with TypeScript support.
Include proper typing and basic structure.

Usage: /component Button

Shell Output

Inject command output using !:

---
description: Analyze test coverage
---

Here are the current test results:
!`npm test`

Based on these results, suggest improvements to increase coverage.

Commands run in the project root directory.

File References in Commands

Include files using @:

---
description: Review component
---

Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.

Frontmatter Options

JSON Configuration

Also possible via opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "command": {
    "test": {
      "template": "Run the full test suite with coverage report.",
      "description": "Run tests with coverage",
      "agent": "build"
    }
  }
}

Config Files

AGENTS.md

Created by /init. Contains project-specific context:

• Project structure overview
• Coding patterns and conventions
• Tech stack information
• Build/test commands

OpenCode Zen (Recommended)

Curated, benchmarked models specifically tested for coding agents. No need to worry about inconsistent performance.

Select "opencode" and sign in at opencode.ai/auth

Other Providers