docs: regenerate all AGENTS.md files with updated structure

2026-01-23 02:14:08 +09:00
parent 0e18efc7e4
commit 7de376e24f
9 changed files with 257 additions and 395 deletions
@@ -2,90 +2,70 @@

 ## OVERVIEW

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

 ## 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
+├── index.ts              # Commander.js entry
+├── install.ts            # Interactive TUI (520 lines)
+├── config-manager.ts     # JSONC parsing (641 lines)
+├── types.ts              # InstallArgs, InstallConfig
 ├── doctor/
-│   ├── index.ts          # Doctor command entry
+│   ├── index.ts          # Doctor entry
 │   ├── runner.ts         # Check orchestration
-│   ├── formatter.ts      # Colored output, symbols
-│   ├── constants.ts      # Check IDs, categories, symbols
+│   ├── formatter.ts      # Colored output
+│   ├── constants.ts      # Check IDs, symbols
 │   ├── types.ts          # CheckResult, CheckDefinition
-│   └── checks/           # 14 checks across 6 categories (21 files)
+│   └── checks/           # 14 checks, 21 files
 │       ├── version.ts    # OpenCode + plugin version
-│       ├── config.ts     # JSONC validity, Zod validation
+│       ├── config.ts     # JSONC validity, Zod
 │       ├── 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
+│       ├── lsp.ts        # LSP connectivity
+│       ├── mcp.ts        # MCP validation
+│       └── gh.ts         # GitHub CLI
 ├── run/
-│   ├── index.ts          # Run command entry
-│   └── runner.ts         # Session launcher
+│   └── index.ts          # Session launcher
 └── get-local-version/
-    ├── index.ts          # Version detection
-    └── formatter.ts      # Version output
+    └── index.ts          # Version detection
 ```

-## CLI COMMANDS
+## 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 |
+| `install` | Interactive setup |
+| `doctor` | 14 health checks |
+| `run` | Launch session |
+| `get-local-version` | Version check |

-## DOCTOR CHECK CATEGORIES
+## DOCTOR CATEGORIES

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

 ## HOW TO ADD CHECK

-1. Create `src/cli/doctor/checks/my-check.ts`:
-   ```typescript
-   export function getMyCheckDefinition(): CheckDefinition {
-     return {
-       id: "my-check",
-       name: "My Check",
-       category: "configuration",
-       check: async () => ({ status: "pass", message: "OK" })
-     }
-   }
-   ```
+1. Create `src/cli/doctor/checks/my-check.ts`
 2. Export from `checks/index.ts`
 3. 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
+- **@clack/prompts**: `select()`, `spinner()`, `intro()`
+- **picocolors**: Terminal colors
+- **Symbols**: ✓ (pass), ✗ (fail), ⚠ (warn)

 ## 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`
+- **Direct JSON.parse**: Use `parseJsonc()`
+- **Silent failures**: Return warn/fail in doctor