Installation
Get Oh My OpenCode up and running in minutes
Prerequisites
Before installing Oh My OpenCode, make sure you have:
- OpenCode - Version 1.0.133 or newer (recommended)
- Node.js - Version 18 or higher
- npm or bun - Package manager
Installation Methods
Using npm
npm install -g oh-my-opencode
Using bun
bun install -g oh-my-opencode
Using yarn
yarn global add oh-my-opencode
Using pnpm
pnpm add -g oh-my-opencode
Verification
After installation, verify that Oh My OpenCode is installed correctly:
opencode --version
You should see the version number of Oh My OpenCode.
Initial Setup
Once installed, initialize your configuration:
opencode init
This will create the initial configuration file at ~/.config/opencode/oh-my-opencode.json.
Configuration File Locations
Oh My OpenCode looks for configuration in the following locations (in order):
.opencode/oh-my-opencode.json- Project-specific configuration~/.config/opencode/oh-my-opencode.json- User-wide configuration
Project-specific configuration takes precedence over user-wide configuration.
Quick Start
After installation and initialization, you're ready to use Oh My OpenCode! Here's what's enabled by default:
Planner-Sisyphus Agent
Enabled by default. Provides intelligent planning and execution.
Learn more →Next Steps
Now that you have Oh My OpenCode installed:
- Review the configuration guide to customize your setup
- Explore available agents and configure them to your needs
- Check out the hooks system for workflow automation
- Read the full documentation for advanced features
Troubleshooting
Installation Issues
If you encounter issues during installation:
- Make sure you have the latest version of Node.js
- Try using a different package manager
- Check that you have write permissions for global installations
- Clear npm/bun cache:
npm cache clean --forceorbun pm cache rm
Configuration Issues
If configuration isn't working:
- Ensure you're using OpenCode 1.0.133 or newer
- Check that the configuration file is valid JSON
- Verify file permissions on the configuration directory
- Check the configuration documentation for syntax
Getting Help
If you're still having issues:
- Check the GitHub Issues
- Search existing issues for similar problems
- Open a new issue with details about your problem
Updating
To update Oh My OpenCode to the latest version:
Using npm
npm update -g oh-my-opencode
Using bun
bun update -g oh-my-opencode
The auto-update-checker hook (enabled by default) will notify you when updates are available.
Uninstallation
To uninstall Oh My OpenCode:
Using npm
npm uninstall -g oh-my-opencode
Using bun
bun remove -g oh-my-opencode
Note: This will not remove your configuration files. To completely remove Oh My OpenCode, also delete:
~/.config/opencode/oh-my-opencode.json.opencode/oh-my-opencode.json(in your projects)