Files

T

justsisyphus 638a314f6d docs: update AGENTS.md files and configuration docs

Refresh documentation across all AGENTS.md files and update configuration documentation with latest features.

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>

2026-01-22 22:48:50 +09:00

3.3 KiB

Raw Blame History

CLI KNOWLEDGE BASE

OVERVIEW

CLI entry point: bunx oh-my-opencode. Interactive installer, doctor diagnostics, session runner. Uses Commander.js + @clack/prompts TUI.

STRUCTURE

cli/
├── index.ts              # Commander.js entry, 5 subcommands
├── install.ts            # Interactive TUI installer (520 lines)
├── config-manager.ts     # JSONC parsing, multi-level merge (641 lines)
├── types.ts              # InstallArgs, InstallConfig, DetectedConfig
├── doctor/
│   ├── index.ts          # Doctor command entry
│   ├── runner.ts         # Check orchestration
│   ├── formatter.ts      # Colored output, symbols
│   ├── constants.ts      # Check IDs, categories, symbols
│   ├── types.ts          # CheckResult, CheckDefinition
│   └── checks/           # 14 checks across 6 categories (21 files)
│       ├── version.ts    # OpenCode + plugin version
│       ├── config.ts     # JSONC validity, Zod validation
│       ├── auth.ts       # Anthropic, OpenAI, Google
│       ├── dependencies.ts # AST-Grep, Comment Checker
│       ├── lsp.ts        # LSP server connectivity
│       ├── mcp.ts        # MCP server validation
│       └── gh.ts         # GitHub CLI availability
├── run/
│   ├── index.ts          # Run command entry
│   └── runner.ts         # Session launcher
└── get-local-version/
    ├── index.ts          # Version detection
    └── formatter.ts      # Version output

CLI COMMANDS

Command	Purpose
`install`	Interactive setup, subscription detection
`doctor`	14 health checks, `--verbose`, `--json`, `--category`
`run`	Launch OpenCode session with completion enforcement
`get-local-version`	Version detection, update checking

DOCTOR CHECK CATEGORIES

Category	Checks
installation	opencode, plugin registration
configuration	config validity, Zod validation
authentication	anthropic, openai, google
dependencies	ast-grep CLI/NAPI, comment-checker
tools	LSP, MCP connectivity
updates	version comparison

HOW TO ADD CHECK

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

export function getMyCheckDefinition(): CheckDefinition {
  return {
    id: "my-check",
    name: "My Check",
    category: "configuration",
    check: async () => ({ status: "pass", message: "OK" })
  }
}

Export from checks/index.ts
Add to getAllCheckDefinitions()

TUI FRAMEWORK

@clack/prompts: select(), spinner(), intro(), outro(), note()
picocolors: Colored terminal output
Symbols: ✓ (pass), ✗ (fail), ⚠ (warn), ○ (skip)

CONFIG-MANAGER

JSONC: Comments (// ...), block comments, trailing commas
Multi-source: User (~/.config/opencode/) + Project (.opencode/)
Env override: OPENCODE_CONFIG_DIR for profile isolation
Validation: Zod schema with error aggregation

ANTI-PATTERNS

Blocking in non-TTY: Check process.stdout.isTTY
Direct JSON.parse: Use parseJsonc() for config
Silent failures: Always return warn/fail in doctor
Hardcoded paths: Use ConfigManager

3.3 KiB Raw Blame History