opencode-add-dir 1.0.0 → 1.0.2

package/README.md

@@ -1,43 +1,68 @@
 # OpenCode Add-Dir Plugin
 
-A plugin for OpenCode that adds the `/add-dir` command to include external directories in your session context.
+Add external directories to your OpenCode session context with automatic permission approval.
 
-## Installation
+## Quick Start
+
+1. Install the plugin:
 
 ```bash
-cd ~/.config/opencode/plugins/add-dir
-bun install
+cd ~/.config/opencode
+npm install opencode-add-dir
 ```
 
-## Features
-
-- Add external directories to session context with `/add-dir <path>`
-- Smart filtering of binary files and common build directories
-- Recursive directory scanning
-- Configurable limits (100KB per file, 500 files max)
-- Read and write access to added directories
+2. Add `"opencode-add-dir"` to your `~/.config/opencode/opencode.jsonc` plugins array:
 
-## Configuration
+```jsonc
+{
+  "plugin": [
+    "your-other-plugins",
+    "opencode-add-dir"
+  ]
+}
+```
 
-The plugin automatically installs its command file to `~/.config/opencode/command/add-dir.md` during installation.
+3. Restart OpenCode
 
-Ensure your `~/.config/opencode/opencode.jsonc` includes:
+4. Use the command:
 
-```jsonc
-"plugin": [
-  "./plugins/add-dir"
-]
+```bash
+/add-dir /path/to/your/project
 ```
 
-## Usage
+## Features
+
+- **Zero Configuration**: Works immediately after installation
+- **Auto Permission**: No permission prompts for directories you add
+- **Smart Filtering**: Automatically skips node_modules, .git, binary files, etc.
+- **Recursive Scanning**: Reads entire directory structures
+- **File Limits**: 100KB per file, 500 files max (to prevent overwhelm)
+- **Full Access**: Read and write to added directories
+
+## How It Works
+
+1. `/add-dir <path>` scans the directory and adds all files to context
+2. Directory path is automatically registered for future access
+3. Any operations on that directory skip permission prompts
+4. Works recursively - all subdirectories are auto-approved
+
+## Usage Examples
 
 ```bash
-/add-dir /path/to/your/project
+# Add a project directory
+/add-dir ~/projects/my-app
+
+# Add any external directory
+/add-dir /path/to/external/code
+
+# Now you can read/write without permission prompts
+read ~/projects/my-app/src/index.js
+edit ~/projects/my-app/package.json
 ```
 
-## Filtering Rules
+## What Gets Filtered
 
-### Ignored Directories
+### Automatically Skipped Directories
 - `node_modules`
 - `.git`
 - `dist`, `build`
@@ -49,29 +74,68 @@ Ensure your `~/.config/opencode/opencode.jsonc` includes:
 - `.nuxt`, `.output`
 - `tmp`, `temp`, `.turbo`
 
-### Binary Files
+### Binary Files (Not Read)
 Images, PDFs, Office docs, archives, media files, executables, compiled files, etc.
 
+## Installation Details
+
+The plugin's postinstall script automatically:
+1. Finds your OpenCode config directory (`~/.config/opencode/`)
+2. Creates the `/add-dir` command file
+3. Installs it to `~/.config/opencode/command/add-dir.md`
+
+### Troubleshooting
+
+If the `/add-dir` command doesn't work after installation:
+
+1. Verify the command file exists:
+```bash
+ls -la ~/.config/opencode/command/add-dir.md
+```
+
+2. If missing, create it manually:
+```bash
+mkdir -p ~/.config/opencode/command
+cat > ~/.config/opencode/command/add-dir.md << 'EOF'
+---
+description: Add an external directory to the session context
+---
+Add the directory at path $ARGUMENTS to this session's context.
+Use the add_dir tool to read all files from the specified directory.
+EOF
+```
+
 ## Development
 
+For contributors and maintainers:
+
 ```bash
-cd ~/.config/opencode/plugins/add-dir
+# Clone the repository
+git clone https://github.com/kuzeofficial/add-dir-opencode.git
+cd opencode-add-dir
 
 # Install dependencies
 bun install
 
-# Build the plugin
+# Build the TypeScript source
 bun run build
 
-# The build output goes to dist/
+# Test locally
+npm link
+cd ~/.config/opencode
+npm link opencode-add-dir
+
+# Publish new version
+npm version patch  # or minor/major
+npm publish
 ```
 
 ## Files
 
-- `src/index.ts` - Main plugin implementation
+- `src/index.ts` - Main plugin with permission auto-approval
 - `command/add-dir.md` - Command definition (auto-installed)
 - `scripts/install.js` - Post-install script (auto-runs)
-- `package.json` - Package configuration
+- `package.json` - NPM package configuration
 
 ## License
 

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "opencode-add-dir",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "OpenCode plugin to add external directories to session context",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "command"
+    "command",
+    "scripts"
   ],
   "scripts": {
     "build": "tsc",

package/scripts/install.js

@@ -0,0 +1,58 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import os from 'os';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const COMMAND_SOURCE = path.join(__dirname, '..', 'command', 'add-dir.md');
+
+function findOpencodeConfigDir(startDir = process.cwd()) {
+  const configFiles = ['opencode.jsonc', 'opencode.json'];
+  let currentDir = startDir;
+
+  while (currentDir !== path.parse(currentDir).root) {
+    for (const configFile of configFiles) {
+      const configPath = path.join(currentDir, configFile);
+      if (fs.existsSync(configPath)) {
+        return currentDir;
+      }
+    }
+    currentDir = path.dirname(currentDir);
+  }
+
+  const defaultConfigDir = path.join(os.homedir(), '.config', 'opencode');
+  if (fs.existsSync(defaultConfigDir)) {
+    return defaultConfigDir;
+  }
+
+  return null;
+}
+
+try {
+  const opencodeDir = findOpencodeConfigDir();
+
+  if (!opencodeDir) {
+    console.log('ℹ opencode-add-dir: Could not find opencode config directory, skipping command file installation');
+    process.exit(0);
+  }
+
+  const commandDir = path.join(opencodeDir, 'command');
+  const commandDest = path.join(commandDir, 'add-dir.md');
+
+  if (!fs.existsSync(commandDir)) {
+    fs.mkdirSync(commandDir, { recursive: true });
+  }
+
+  if (fs.existsSync(COMMAND_SOURCE)) {
+    fs.copyFileSync(COMMAND_SOURCE, commandDest);
+    console.log('✓ opencode-add-dir: Command file installed to', commandDest);
+  } else {
+    console.error('✗ opencode-add-dir: Command source file not found at', COMMAND_SOURCE);
+    process.exit(1);
+  }
+} catch (error) {
+  console.error('✗ opencode-add-dir: Failed to install command file:', error.message);
+  process.exit(1);
+}