Your comprehensive guide to mastering OpenCode, designed for new users and smooth transitions from Claude Code.
This repository serves as a practical guide for users looking to leverage OpenCode, an interactive CLI agent for software engineering tasks. Whether you're new to AI-powered coding assistants or transitioning from Claude Code, this guide will provide you with the necessary knowledge and hands-on examples to get started and become proficient.
For Claude Code Users: We'll highlight the similarities and differences, provide direct command and workflow equivalents, and offer tips for a smooth transition.
For New OpenCode Users: We'll offer a structured learning path, covering everything from basic concepts to advanced workflows, ensuring you can confidently integrate OpenCode into your development process.
- Tool-Based Interaction: OpenCode operates by calling specialized tools for specific tasks (e.g., reading files, executing shell commands, editing code).
- Contextual Understanding: It leverages conversation history and codebase context to inform its actions.
- Safety and Conventions: OpenCode prioritizes safe operations, adheres to project conventions, and provides clear explanations for its actions.
- Complex Task Delegation: Capable of handling multi-step software engineering tasks autonomously.
To begin your journey with OpenCode, follow these simple steps:
-
Install OpenCode:
# Replace with actual OpenCode installation command npm install -g opencode-cli # Example, verify official documentation
-
Your First Command:
Once installed, try a basic command to ensure everything is working:
opencode --help
This will display the available commands and general usage information.
- Command Reference - Quick lookup for all commands
- Introduction to OpenCode
- Getting Started
- Core Concepts
- Common Workflows
- Claude to OpenCode Migration
- Best Practices
- FAQ and Troubleshooting
- OpenCode Products: Zen, Go, Enterprise
- Plugins Guide - Extend OpenCode capabilities
- MCP Servers Guide - Connect to external services
- AI Models Guide - Choose the right model