opencode-agent-tmux 1.0.0 → 1.0.4

package/README.md

@@ -1,47 +1,40 @@
 # opencode-agent-tmux
 
-OpenCode plugin that provides tmux integration for viewing agent execution in real-time. Automatically spawns panes, streams output, and manages your terminal workspace.
+[![npm version](https://img.shields.io/npm/v/opencode-agent-tmux.svg)](https://www.npmjs.com/package/opencode-agent-tmux)
+[![npm downloads](https://img.shields.io/npm/dt/opencode-agent-tmux)](https://www.npmjs.com/package/opencode-agent-tmux)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## 🤖 For Humans (Quick Start)
+An [OpenCode](https://opencode.ai) plugin that provides **smart tmux integration** for viewing agent execution in real-time. Automatically spawns panes, streams output, and manages your terminal workspace.
 
-Want to get started immediately? Just paste this prompt into your OpenCode agent (or any other agentic tool like Claude Code) and let it handle the setup for you:
+- **Agent-Agnostic**: Works with oh-my-opencode, omoc-slim, or vanilla OpenCode.
+- **Cross-Platform**: Full support for **macOS**, **Linux**, and **Windows** (via PowerShell or WSL).
 
-```text
-Please install the opencode-agent-tmux plugin for me.
+![Demo](https://via.placeholder.com/800x400?text=Imagine+Cool+Tmux+Demo+Here)
 
-1. Clone the repository to ~/Code/opencode-agent-tmux
-2. Run 'bun install' and 'bun run build' inside the directory
-3. Add the plugin path to my ~/.config/opencode/opencode.json file
-4. Verify the installation by running 'opencode --version'
+## Installation
 
-The plugin repo is: https://github.com/AnganSamadder/opencode-agent-tmux.git
-```
+### 🤖 Let an LLM do it (Recommended)
 
-## ✨ Features
+Paste this into any LLM agent (OpenCode, Claude Code, Cursor, etc.):
 
-- **Automatic Tmux Pane Spawning**: When any agent starts, automatically spawns a tmux pane
-- **Live Streaming**: Each pane runs `opencode attach` to show real-time agent output
-- **Auto-Cleanup**: Panes automatically close when agents complete
-- **Configurable Layout**: Support multiple tmux layouts (main-vertical, tiled, etc.)
-- **Multi-Port Support**: Automatically finds available ports when running multiple instances
-- **Agent-Agnostic**: Works with oh-my-opencode, omoc-slim, or vanilla OpenCode
-
-## 📋 Requirements
+```text
+Install the opencode-agent-tmux plugin by following: https://raw.githubusercontent.com/AnganSamadder/opencode-agent-tmux/main/README.md
+```
 
-- **OpenCode**
-- **tmux**
-- **Bun** (for building)
+<details>
+<summary><b>Instructions for LLM Agents</b></summary>
 
-## 📦 Installation (Official)
+To install this plugin, please perform the following steps for the user:
 
-1.  **Install via NPM:**
+1.  **Install the NPM package globally:**
     ```bash
     npm install -g opencode-agent-tmux
     ```
-    *Note: The installation automatically configures a shell alias to enable the smart tmux wrapper.*
+    *Note: This installer automatically configures the user's shell (Bash/Zsh/Fish/PowerShell) to use the smart wrapper.*
 
 2.  **Configure OpenCode:**
-    Add the plugin name to your `~/.config/opencode/opencode.json`:
+    Add `"opencode-agent-tmux"` to the `plugins` array in the user's config file (usually `~/.config/opencode/opencode.json`).
+
     ```json
     {
       "plugins": [
@@ -50,72 +43,41 @@ The plugin repo is: https://github.com/AnganSamadder/opencode-agent-tmux.git
     }
     ```
 
-## 🛠 Manual Installation (Development)
+3.  **Verify & Finalize:**
+    *   Check if `tmux` is installed on the system. If not, advise the user to install it (e.g., `brew install tmux`, `sudo apt install tmux`, or `winget install tmux`).
+    *   Tell the user: **"Installation complete! Please restart your terminal and run `opencode` to see the tmux integration in action."**
 
-If you prefer to install it yourself:
+</details>
 
-1.  **Clone the repository:**
-    ```bash
-    git clone https://github.com/AnganSamadder/opencode-agent-tmux.git ~/Code/opencode-agent-tmux
-    ```
+### 👤 For Humans (Manual)
 
-2.  **Build the plugin:**
+1.  **Install via NPM:**
     ```bash
-    cd ~/Code/opencode-agent-tmux
-    bun install
-    bun run build
+    npm install -g opencode-agent-tmux
     ```
+    *The installer automatically configures your shell to use the smart wrapper.*
 
-3.  **Configure OpenCode:**
-    Add the plugin to your `~/.config/opencode/opencode.json`:
+2.  **Enable the Plugin:**
+    Add `"opencode-agent-tmux"` to your `~/.config/opencode/opencode.json`:
     ```json
     {
       "plugins": [
-        "~/Code/opencode-agent-tmux"
+        "opencode-agent-tmux"
       ]
     }
     ```
 
-## 🚀 Usage
-
-### Easy Mode (Recommended)
-
-After installation, just type:
+3.  **Run OpenCode:**
+    Restart your terminal and type `opencode`. The plugin handles the rest!
 
-```bash
-opencode
-```
-
-The wrapper automatically:
-- Launches tmux if you're not already in it
-- Finds an available port (4096-4106) if default is in use
-- Starts OpenCode with the available port
-- Enables the plugin to spawn panes for agents
-
-### Running Multiple Instances
-
-Want to run multiple OpenCode sessions? No problem:
-
-```bash
-# Terminal 1
-opencode
-# → Starts on port 4096
-
-# Terminal 2
-opencode
-# → Detects 4096 in use, automatically uses port 4097
-```
-
-Each instance works independently with its own tmux panes!
-
-### Manual Mode
-
-Or start OpenCode inside tmux manually:
+## ✨ Features
 
-```bash
-tmux
-opencode --port 4096
-```
+- **Automatic Tmux Pane Spawning**: When any agent starts, automatically spawns a tmux pane
+- **Live Streaming**: Each pane runs `opencode attach` to show real-time agent output
+- **Auto-Cleanup**: Panes automatically close when agents complete
+- **Configurable Layout**: Support multiple tmux layouts (`main-vertical`, `tiled`, etc.)
+- **Multi-Port Support**: Automatically finds available ports (4096-4106) when running multiple instances
+- **Smart Wrapper**: Automatically detects if you are in tmux; if not, launches a session for you.
 
 ## ⚙️ Configuration
 
@@ -143,20 +105,15 @@ You can customize behavior by creating `~/.config/opencode/opencode-agent-tmux.j
 
 ### Panes Not Spawning
 1. Verify you're inside tmux: `echo $TMUX`
-2. Check tmux is installed: `which tmux`
-3. Check OpenCode server is running with port: `opencode --port 4096`
-4. Check logs: `cat /tmp/opencode-agent-tmux.log`
+2. Check tmux is installed: `which tmux` (or `where tmux` on Windows)
+3. Check logs: `cat /tmp/opencode-agent-tmux.log`
 
 ### Server Not Found
-Make sure OpenCode is started with the `--port` flag matching your config:
-```bash
-opencode --port 4096
-```
+Make sure OpenCode is started with the `--port` flag matching your config (the wrapper does this automatically).
 
 ## 📄 License
 
 MIT
 
 ## 🙏 Acknowledgements
-
 This project extracts and improves upon the tmux session management from [oh-my-opencode-slim](https://github.com/alvinunreal/oh-my-opencode-slim) by alvinunreal.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-agent-tmux",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "OpenCode plugin that provides tmux integration for viewing agent execution in real-time",
   "type": "module",
   "main": "dist/index.js",

package/scripts/install.js

@@ -1,8 +1,12 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const HOME = os.homedir();