oh-my-openagent/docs/cli-guide.md

Oh-My-OpenCode CLI Guide

This document provides a comprehensive guide to using the Oh-My-OpenCode CLI tools.

1. Overview

Oh-My-OpenCode provides CLI tools accessible via the bunx oh-my-opencode command. The CLI supports various features including plugin installation, environment diagnostics, and session execution.

# Basic execution (displays help)
bunx oh-my-opencode

# Or run with npx
npx oh-my-opencode

---

2. Available Commands

Command	Description
install	Interactive Setup Wizard
doctor	Environment diagnostics and health checks
run	OpenCode session runner
auth	Google Antigravity authentication management
version	Display version information

---

3. install - Interactive Setup Wizard

An interactive installation tool for initial Oh-My-OpenCode setup. Provides a beautiful TUI (Text User Interface) based on @clack/prompts.

Usage

bunx oh-my-opencode install

Installation Process

1. Provider Selection: Choose your AI provider from Claude, ChatGPT, or Gemini.
2. API Key Input: Enter the API key for your selected provider.
3. Configuration File Creation: Generates opencode.json or oh-my-opencode.json files.
4. Plugin Registration: Automatically registers the oh-my-opencode plugin in OpenCode settings.

Options

Option	Description
--no-tui	Run in non-interactive mode without TUI (for CI/CD environments)
--verbose	Display detailed logs

---

4. doctor - Environment Diagnostics

Diagnoses your environment to ensure Oh-My-OpenCode is functioning correctly. Performs 17+ health checks.

Usage

bunx oh-my-opencode doctor

Diagnostic Categories

Category	Check Items
Installation	OpenCode version (>= 1.0.150), plugin registration status
Configuration	Configuration file validity, JSONC parsing
Authentication	Anthropic, OpenAI, Google API key validity
Dependencies	Bun, Node.js, Git installation status
Tools	LSP server status, MCP server status
Updates	Latest version check

Options

Option	Description
--category <name>	Check specific category only (e.g., --category authentication)
--json	Output results in JSON format
--verbose	Include detailed information

Example Output

oh-my-opencode doctor

┌──────────────────────────────────────────────────┐
│  Oh-My-OpenCode Doctor                           │
└──────────────────────────────────────────────────┘

Installation
  ✓ OpenCode version: 1.0.155 (>= 1.0.150)
  ✓ Plugin registered in opencode.json

Configuration
  ✓ oh-my-opencode.json is valid
  ⚠ categories.visual-engineering: using default model

Authentication
  ✓ Anthropic API key configured
  ✓ OpenAI API key configured
  ✗ Google API key not found

Dependencies
  ✓ Bun 1.2.5 installed
  ✓ Node.js 22.0.0 installed
  ✓ Git 2.45.0 installed

Summary: 10 passed, 1 warning, 1 failed

---

5. run - OpenCode Session Runner

Executes OpenCode sessions and monitors task completion.

Usage

bunx oh-my-opencode run [prompt]

Options

Option	Description
--enforce-completion	Keep session active until all TODOs are completed
--timeout <seconds>	Set maximum execution time

---

6. auth - Authentication Management

Manages Google Antigravity OAuth authentication. Required for using Gemini models.

Usage

# Login
bunx oh-my-opencode auth login

# Logout
bunx oh-my-opencode auth logout

# Check current status
bunx oh-my-opencode auth status

---

7. Configuration Files

The CLI searches for configuration files in the following locations (in priority order):

1. Project Level: .opencode/oh-my-opencode.json
2. User Level: ~/.config/opencode/oh-my-opencode.json

JSONC Support

Configuration files support JSONC (JSON with Comments) format. You can use comments and trailing commas.

{
  // Agent configuration
  "sisyphus_agent": {
    "disabled": false,
    "planner_enabled": true,
  },
  
  /* Category customization */
  "categories": {
    "visual-engineering": {
      "model": "google/gemini-3-pro-preview",
    },
  },
}

---

8. Troubleshooting

"OpenCode version too old" Error

# Update OpenCode
npm install -g opencode@latest
# or
bun install -g opencode@latest

"Plugin not registered" Error

# Reinstall plugin
bunx oh-my-opencode install

Doctor Check Failures

# Diagnose with detailed information
bunx oh-my-opencode doctor --verbose

# Check specific category only
bunx oh-my-opencode doctor --category authentication

---

9. Non-Interactive Mode

Use the --no-tui option for CI/CD environments.

# Run doctor in CI environment
bunx oh-my-opencode doctor --no-tui --json

# Save results to file
bunx oh-my-opencode doctor --json > doctor-report.json

---

10. Developer Information

CLI Structure

src/cli/
├── index.ts              # Commander.js-based main entry
├── install.ts            # @clack/prompts-based TUI installer
├── config-manager.ts     # JSONC parsing, multi-source config management
├── doctor/               # Health check system
│   ├── index.ts          # Doctor command entry
│   └── checks/           # 17+ individual check modules
├── run/                  # Session runner
└── commands/auth.ts      # Authentication management

Adding New Doctor Checks

1. Create src/cli/doctor/checks/my-check.ts:

import type { DoctorCheck } from "../types"

export const myCheck: DoctorCheck = {
  name: "my-check",
  category: "environment",
  check: async () => {
    // Check logic
    const isOk = await someValidation()
    
    return {
      status: isOk ? "pass" : "fail",
      message: isOk ? "Everything looks good" : "Something is wrong",
    }
  },
}

2. Register in src/cli/doctor/checks/index.ts:

export { myCheck } from "./my-check"