Browse Source

New release

Alvin Unreal 6 months ago
parent
commit
fa80133989
3 changed files with 93 additions and 133 deletions
  1. 85 125
      README.md
  2. 1 1
      package.json
  3. 7 7
      src/agents/orchestrator.ts

+ 85 - 125
README.md

@@ -23,26 +23,14 @@
   - [For LLM Agents](#for-llm-agents)
 - [🏗️ **Architecture & Flow**](#architecture--flow)
 - [🏛️ **Meet the Pantheon**](#meet-the-pantheon)
-  - [Orchestrator](#orchestrator)
-  - [Explorer](#explorer)
-  - [Oracle](#oracle)
-  - [Librarian](#librarian)
-  - [Frontend Designer](#frontend-designer)
-  - [Document Writer](#document-writer)
-  - [Multimodal Viewer](#multimodal-viewer)
-  - [Code Simplifier](#code-simplifier)
 - [🛠️ **Tools & Capabilities**](#tools--capabilities)
-  - [Tmux Integration](#tmux-integration)
-  - [Quota Tool](#quota-tool)
-  - [Background Tasks](#background-tasks)
-  - [LSP Tools](#lsp-tools)
-  - [Code Search Tools](#code-search-tools)
 - [🧩 **Skills**](#-skills)
-  - [Playwright Integration](#playwright-integration)
-- [🔌 **MCP Servers**](#mcp-servers)
-- [⚙️ **Configuration**](#configuration)
-  - [Disabling Agents](#disabling-agents)
-  - [Agent Variants](#agent-variants)
+- [⚙️ **Configuration Guide**](#configuration-guide)
+  - [Locations & Precedence](#locations--precedence)
+  - [General Settings](#general-settings)
+  - [Agent Configuration](#agent-configuration)
+  - [Tmux Setup](#tmux-setup)
+  - [MCP Management](#mcp-management)
 - [🗑️ **Uninstallation**](#uninstallation)
 
 ---
@@ -352,71 +340,6 @@ Identify unnecessary complexity, challenge premature abstractions, estimate LOC
 - **Auto-Cleanup**: Panes close when agents finish, layout rebalances
 - **Zero Overhead**: Works with OpenCode's built-in `task` tool AND our `background_task` tool
 
-#### Quick Setup
-
-**1. Enable the OpenCode HTTP server** (one-time setup)
-
-Add to your `~/.config/opencode/opencode.json`:
-
-```json
-{
-  "server": {
-    "port": 4096
-  }
-}
-```
-
-**2. Enable tmux integration in the plugin**
-
-Add to your `~/.config/opencode/oh-my-opencode-slim.json`:
-
-```json
-{
-  "tmux": {
-    "enabled": true,
-    "layout": "main-vertical",
-    "main_pane_size": 60
-  }
-}
-```
-
-**3. Run OpenCode inside tmux**
-
-```bash
-tmux
-opencode
-```
-
-That's it. When agents spawn, they'll appear in new panes.
-
-#### Layout Options
-
-| Layout | Description |
-|--------|-------------|
-| `main-vertical` | Your session on the left (60%), agents stacked on the right |
-| `main-horizontal` | Your session on top (60%), agents stacked below |
-| `tiled` | All panes in equal-sized grid |
-| `even-horizontal` | All panes side by side |
-| `even-vertical` | All panes stacked vertically |
-
-#### Configuration Reference
-
-```json
-{
-  "tmux": {
-    "enabled": true,
-    "layout": "main-vertical",
-    "main_pane_size": 60
-  }
-}
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `enabled` | boolean | `false` | Enable/disable tmux integration |
-| `layout` | string | `"main-vertical"` | Tmux layout preset |
-| `main_pane_size` | number | `60` | Size of main pane as percentage (20-80) |
-
 ---
 
 ### Quota Tool
@@ -433,7 +356,6 @@ For Antigravity users. You can trigger this at any time by asking the agent to *
 
 ### Background Tasks
 
-
 The plugin provides tools to manage asynchronous work:
 
 | Tool | Description |
@@ -489,58 +411,44 @@ Skills are specialized capabilities that combine MCP servers with specific instr
 
 ---
 
-## MCP Servers
+## ⚙️ Configuration Guide
 
-Built-in Model Context Protocol servers (enabled by default):
+The Pantheon listens to your commands through sacred JSON scriptures. Here is how you shape their behavior.
 
-| MCP | Purpose | URL |
-|-----|---------|-----|
-| `websearch` | Real-time web search via Exa AI | `https://mcp.exa.ai/mcp` |
-| `context7` | Official library documentation | `https://mcp.context7.com/mcp` |
-| `grep_app` | GitHub code search via grep.app | `https://mcp.grep.app` |
+### Locations & Precedence
 
-### Disabling MCPs
+The plugin merges configuration from two locations. Settings in the **Project Local** file override those in the **User Global** file.
 
-You can disable specific MCP servers in your config:
+| Level | Path | Scope |
+| :--- | :--- | :--- |
+| **User Global** | `~/.config/opencode/oh-my-opencode-slim.json` | All projects for this user |
+| **Project Local** | `./.opencode/oh-my-opencode-slim.json` | This specific repository |
 
-```json
-{
-  "disabled_mcps": ["websearch", "grep_app"]
-}
-```
+> **Note for Windows Users:** The global config is located at `%APPDATA%\opencode\oh-my-opencode-slim.json` or `~/.config/opencode/oh-my-opencode-slim.json`.
 
 ---
 
-## Configuration
-
-You can customize the behavior of the plugin via JSON configuration files.
-
-### Configuration Files
-
-The plugin looks for configuration in two places (and merges them):
-
-1. **User Global**: `~/.config/opencode/oh-my-opencode-slim.json` (or OS equivalent)
-2. **Project Local**: `./.opencode/oh-my-opencode-slim.json`
+### General Settings
 
-| Platform | User Config Path |
-| :--- | :--- |
-| **Windows** | `~/.config/opencode/oh-my-opencode-slim.json` or `%APPDATA%\opencode\oh-my-opencode-slim.json` |
-| **macOS/Linux** | `~/.config/opencode/oh-my-opencode-slim.json` |
-
-### Disabling Agents
-
-You can disable specific agents using the `disabled_agents` array:
+#### OpenCode Server
+To enable certain integrations (like Tmux), you must first enable the OpenCode HTTP server in your main `opencode.json` file.
 
+**File:** `~/.config/opencode/opencode.json`
 ```json
 {
-  "disabled_agents": ["multimodal-looker", "code-simplicity-reviewer"]
+  "server": {
+    "port": 4096
+  }
 }
 ```
 
+---
+
 ### Agent Configuration
 
-You can fully customize each agent's behavior by overriding its model and reasoning variant. This allows you to balance cost and performance for specific tasks.
+You can customize the underlying LLM and reasoning effort for each deity in the Pantheon.
 
+**File:** `oh-my-opencode-slim.json`
 ```json
 {
   "agents": {
@@ -552,23 +460,75 @@ You can fully customize each agent's behavior by overriding its model and reason
       "model": "opencode/glm-4.7",
       "variant": "low"
     }
+  },
+  "disabled_agents": ["multimodal-looker", "code-simplicity-reviewer"]
+}
+```
+
+#### Agent Settings Reference
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `agents.<name>.model` | string | *Varies* | Override the LLM for a specific agent |
+| `agents.<name>.variant` | string | `"medium"` | Reasoning level (`low`, `medium`, `high`) |
+| `disabled_agents` | array | `[]` | List of agents to completely deactivate |
+
+---
+
+### Tmux Setup
+
+Watch your agents work in real-time by enabling the Tmux integration. This requires the [OpenCode Server](#opencode-server) to be active.
+
+**File:** `oh-my-opencode-slim.json`
+```json
+{
+  "tmux": {
+    "enabled": true,
+    "layout": "main-vertical",
+    "main_pane_size": 60
   }
 }
 ```
 
-| Option | Type | Values | Description |
-|--------|------|--------|-------------|
-| `agents.<name>.model` | string | Any valid model ID | Override the underlying LLM for this agent |
-| `agents.<name>.variant` | string | `"low"`, `"medium"`, `"high"` | Reasoning effort level for this agent (when supported) |
+#### Tmux Settings Reference
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `enabled` | boolean | `false` | Enable/disable tmux integration |
+| `layout` | string | `"main-vertical"` | Layout preset (see below) |
+| `main_pane_size` | number | `60` | Size of main session pane as % (20-80) |
 
-These settings are applied when the plugin launches background tasks or sync agent calls.
+**Available Layouts:**
+- `main-vertical`: Main session left, agents stacked right.
+- `main-horizontal`: Main session top, agents stacked below.
+- `tiled`: Equal-sized grid.
+- `even-horizontal` / `even-vertical`: Evenly distributed panes.
 
 ---
 
-## Uninstallation
+### MCP Management
 
-1. **Remove the plugin from your OpenCode config**:
+The Pantheon comes equipped with built-in Model Context Protocol (MCP) servers.
+
+| MCP | Purpose | URL |
+|-----|---------|-----|
+| `websearch` | Real-time web search via Exa AI | `https://mcp.exa.ai/mcp` |
+| `context7` | Official library documentation | `https://mcp.context7.com/mcp` |
+| `grep_app` | GitHub code search via grep.app | `https://mcp.grep.app` |
 
+#### Disabling MCPs
+If you wish to silence an MCP server, add it to the `disabled_mcps` array in your config:
+
+**File:** `oh-my-opencode-slim.json`
+```json
+{
+  "disabled_mcps": ["websearch", "grep_app"]
+}
+```
+
+---
+
+## 🗑️ 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)**:

+ 1 - 1
package.json

@@ -1,6 +1,6 @@
 {
   "name": "oh-my-opencode-slim",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Lightweight agent orchestration plugin for OpenCode - a slimmed-down fork of oh-my-opencode",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

+ 7 - 7
src/agents/orchestrator.ts

@@ -28,13 +28,13 @@ You are an AI coding orchestrator. You DO NOT implement - you DELEGATE.
 **Core Rule:** If a specialist agent can do the work, YOU MUST delegate to them.
 
 **Why Delegation Matters:**
-- @frontend-ui-ux-engineer → 10x better designs than you
-- @librarian → finds docs you'd miss
-- @explore → searches faster than you
-- @oracle → catches architectural issues you'd overlook
-- @document-writer → writes cleaner docs for less cost
-- @code-simplicity-reviewer → spots complexity you're blind to
-- @multimodal-looker → understands images you can't parse
+- @frontend-ui-ux-engineer → 10x better designs than you → improves quality
+- @librarian → finds docs you'd miss → improves speed and quality
+- @explore → searches faster than you →  improves speed
+- @oracle → catches architectural issues you'd overlook → improves quality
+- @document-writer → writes cleaner docs for less cost → reduceses cost
+- @code-simplicity-reviewer → spots complexity you're blind to → improves quality
+- @multimodal-looker → understands images you can't parse → improves speed and quality
 
 **Your value is in orchestration, not implementation.**
 </Role>