Documentation

Getting Started

Quick Start Guide

1. Install Oh My OpenCode
2. Configure your setup
3. Start using agents and features

Essential Reading

• Installation Guide - Get Oh My OpenCode installed
• Configuration Guide - Customize your setup
• Features Overview - Learn what's available
• OpenCode Tutorial - Step-by-step CLI and plugin setup
• FAQ - Common questions about installation, configuration, and compatibility
• Oh My OpenCode vs OpenCode - When to use the plugin
• Use Cases - Monorepos, build pipelines, team workflows
• OpenCode vs Cursor - Compare with IDE-centered tools
• Best OpenCode Plugins - Ecosystem overview

Configuration

Configuration Files

• ~/.config/opencode/oh-my-opencode.json - User-wide configuration
• .opencode/oh-my-opencode.json - Project-specific configuration

Configuration Topics

• Agents Configuration
• Hooks Configuration
• MCPs Configuration
• LSP Configuration
• Experimental Features

Agents

Oh My OpenCode includes several specialized agents:

• Planner-Sisyphus - Default planning and execution agent
• Librarian - Documentation and code exploration
• Explore - Code navigation and discovery
• Oracle - Question answering and explanations

View Complete Agents Documentation →

Hooks

20+ built-in hooks for workflow automation:

Hook Categories

• Task Management - todo-continuation-enforcer, empty-task-response-detector
• Context Management - context-window-monitor, compaction-context-injector, preemptive-compaction
• Session Management - session-recovery, session-notification, auto_resume
• Code Quality - comment-checker, thinking-block-validator
• Output Management - grep-output-truncator, tool-output-truncator
• Workflow - directory-agents-injector, directory-readme-injector, rules-injector

View Complete Hooks Documentation →

MCPs (Model Context Protocol)

MCP integration provides enhanced capabilities:

• Context7 - Up-to-date documentation (enabled by default)
• grep.app - Ultra-fast code search (enabled by default)

View Complete MCPs Documentation →

LSP (Language Server Protocol)

Full LSP support with refactoring tools:

• Code analysis and type checking
• Refactoring tools (rename, code actions)
• Custom LSP server configuration
• Priority management for multiple servers

View Complete LSP Documentation →

Advanced Topics

Experimental Features

• Preemptive Compaction
• Truncate All Outputs
• Aggressive Truncation
• Auto Resume
• DCP for Compaction

Best Practices

• Start with default configuration
• Enable features as needed
• Use project-specific configuration
• Monitor performance and adjust

Troubleshooting

Common Issues

Installation Issues

• Ensure Node.js 18+ is installed
• Check package manager permissions
• Clear cache and retry

Configuration Issues

• Verify JSON syntax is valid
• Check OpenCode version (1.0.133+)
• Review configuration file locations

Performance Issues

• Disable unused hooks and MCPs
• Adjust experimental feature settings
• Check context window usage

Getting Help

• GitHub Issues
• Search existing issues
• Open a new issue with details

Additional Resources

Related Pages

These pages help you get more traffic and context:

• Installation — Get Oh My OpenCode installed
• OpenCode Tutorial — Step-by-step from zero to first session
• Configuration — oh-my-opencode.json and options
• FAQ — Common questions and troubleshooting
• Oh My OpenCode vs OpenCode — What the plugin adds
• Best OpenCode Plugins — Ecosystem overview
• OpenCode CLI Commands — Common commands reference
• OpenCode Alternatives — Compare with Cursor and other tools