Skip to content

installation.md

Latest commit

 

History

History
203 lines (140 loc) · 5.19 KB

installation.md

File metadata and controls

203 lines (140 loc) · 5.19 KB
Raw

Installation Guide

Complete installation instructions for oh-my-opencode-slim.

Table of Contents

For Humans

Quick Install

Run the interactive installer:

bunx oh-my-opencode-slim@latest install

Or use non-interactive mode:

bunx oh-my-opencode-slim@latest install --no-tui --kimi=yes --openai=yes --tmux=no

After Installation

Authenticate with your providers:

opencode auth login
# Select your provider → Complete OAuth flow
# Repeat for each provider you enabled

Once authenticated, run opencode and ping all agents to verify all agents respond.

💡 Tip: Models are fully customizable. The installer sets sensible defaults, but you can assign any model to any agent. Edit ~/.config/opencode/oh-my-opencode-slim.json to override models, adjust reasoning effort, or disable agents entirely. See Configuration for details.

Alternative: Ask Any Coding Agent

Paste this into Claude Code, AmpCode, Cursor, or any coding agent:

Install and configure by following the instructions here:
https://raw.githubusercontent.com/alvinunreal/oh-my-opencode-slim/refs/heads/master/README.md

For LLM Agents

If you're an LLM Agent helping set up oh-my-opencode-slim, follow these steps.

Step 1: Check OpenCode Installation

opencode --version

If not installed, direct the user to https://opencode.ai/docs first.

Step 2: Ask About Provider Access

Ask these questions one at a time, waiting for responses:

  1. "Do you have access to Kimi For Coding?" (Provides Kimi k1.5 models)
  2. "Do you have access to OpenAI API?" (Enables openai/ models)

Help the user understand the tradeoffs:

  • Kimi For Coding provides powerful k1.5 models for coding tasks.
  • OpenAI is optional; it enables openai/ models.
  • If the user has no providers, the plugin still works using OpenCode Zen free models (opencode/big-pickle). They can switch to paid providers later by editing ~/.config/opencode/oh-my-opencode-slim.json.

Step 3: Run the Installer

Based on answers, run:

bunx oh-my-opencode-slim@latest install --no-tui --kimi=<yes|no> --openai=<yes|no>

Examples:

# Kimi + OpenAI
bunx oh-my-opencode-slim@latest install --no-tui --kimi=yes --openai=yes --tmux=no

# OpenAI only
bunx oh-my-opencode-slim@latest install --no-tui --kimi=no --openai=yes --tmux=no

# No providers (Zen free models only)
bunx oh-my-opencode-slim@latest install --no-tui --kimi=no --openai=no --tmux=no

The installer automatically:

  • Adds the plugin to ~/.config/opencode/opencode.json
  • Generates agent model mappings in ~/.config/opencode/oh-my-opencode-slim.json

Crucial Advice for the User:

  • They can easily assign different models to different agents by editing ~/.config/opencode/oh-my-opencode-slim.json.
  • If they add a new provider later, they just need to update this file.
  • Read generated ~/.config/opencode/oh-my-opencode-slim.json file and report the model configuration.

Step 4: Authenticate with Providers

For Kimi (if enabled): Ask user to run the following command. Don't run it yourself, it requires user interaction.

opencode auth login
# Select "Kimi For Coding" provider and complete OAuth flow

For OpenAI (if enabled): Ask user to run the following command. Don't run it yourself, it requires user interaction.

opencode auth login
# Select your provider and complete OAuth flow

Troubleshooting

Installer Fails

Check the expected config format:

bunx oh-my-opencode-slim@latest install --help

Then manually create the config files at:

  • ~/.config/opencode/oh-my-opencode-slim.json

Agents Not Responding

  1. Check your authentication:

    opencode auth status

  2. Verify your config file exists and is valid:

    cat ~/.config/opencode/oh-my-opencode-slim.json

  3. Check that your provider is configured in ~/.config/opencode/opencode.json

Authentication Issues

If providers are not working:

  1. Check your authentication status:

    opencode auth status

  2. Re-authenticate if needed:

    opencode auth login

  3. Verify your config file has the correct provider configuration:

    cat ~/.config/opencode/oh-my-opencode-slim.json

Tmux Integration Not Working

Make sure you're running OpenCode with the --port flag and the port matches your OPENCODE_PORT environment variable:

tmux
export OPENCODE_PORT=4096
opencode --port 4096

See the Quick Reference for more details.

Uninstallation

  1. Remove the plugin from your OpenCode config:

    Edit ~/.config/opencode/opencode.json and remove "oh-my-opencode-slim" from the plugin array.

  2. Remove configuration files (optional):

    rm -f ~/.config/opencode/oh-my-opencode-slim.json
rm -f .opencode/oh-my-opencode-slim.json

  3. Remove skills (optional):

    npx skills remove simplify
npx skills remove agent-browser