@intellectronica/ruler 0.2.12 → 0.2.14

package/README.md

@@ -10,6 +10,7 @@
 ---
 
 > **Beta Research Preview**
+>
 > - Please test this version carefully in your environment
 > - Report issues at https://github.com/intellectronica/ruler/issues
 
@@ -35,22 +36,23 @@ Ruler solves this by providing a **single source of truth** for all your AI agen
 
 ## Supported AI Agents
 
-| Agent            | Rules File(s)                                    | MCP Configuration                                |
-| ---------------- | ------------------------------------------------ | ------------------------------------------------ |
-| GitHub Copilot   | `.github/copilot-instructions.md`                | `.vscode/mcp.json`                               |
-| Claude Code      | `CLAUDE.md`                                      | `claude_desktop_config.json`                     |
-| OpenAI Codex CLI | `AGENTS.md`                                      | `~/.codex/config.json`                           |
-| Jules            | `AGENTS.md`                                      | -                                                |
-| Cursor           | `.cursor/rules/ruler_cursor_instructions.mdc`    | `.cursor/mcp.json`, `~/.cursor/mcp.json`         |
-| Windsurf         | `.windsurf/rules/ruler_windsurf_instructions.md` | `~/.codeium/windsurf/mcp_config.json`            |
-| Cline            | `.clinerules`                                    | -                                                |
-| Aider            | `ruler_aider_instructions.md`, `.aider.conf.yml` | `.mcp.json`                                      |
-| Firebase Studio  | `.idx/airules.md`                                | -                                                |
-| Open Hands       | `.openhands/microagents/repo.md`                 | `.openhands/config.toml`                         |
-| Gemini CLI       | `GEMINI.md`                                      | `.gemini/settings.json`                          |
-| Junie            | `.junie/guidelines.md`                           | -                                                |
-| AugmentCode      | `.augment/rules/ruler_augment_instructions.md`   | `.vscode/settings.json`                          |
-| Kilo Code        | `.kilocode/rules/ruler_kilocode_instructions.md` | `.kilocode/mcp.json`                             |
+| Agent            | Rules File(s)                                    | MCP Configuration                                   |
+| ---------------- | ------------------------------------------------ | --------------------------------------------------- |
+| GitHub Copilot   | `.github/copilot-instructions.md`                | `.vscode/mcp.json`                                  |
+| Claude Code      | `CLAUDE.md`                                      | `claude_desktop_config.json`                        |
+| OpenAI Codex CLI | `AGENTS.md`                                      | `~/.codex/config.json`                              |
+| Jules            | `AGENTS.md`                                      | -                                                   |
+| Cursor           | `.cursor/rules/ruler_cursor_instructions.mdc`    | `.cursor/mcp.json`, `~/.cursor/mcp.json`            |
+| Windsurf         | `.windsurf/rules/ruler_windsurf_instructions.md` | `~/.codeium/windsurf/mcp_config.json`               |
+| Cline            | `.clinerules`                                    | -                                                   |
+| Aider            | `ruler_aider_instructions.md`, `.aider.conf.yml` | `.mcp.json`                                         |
+| Firebase Studio  | `.idx/airules.md`                                | -                                                   |
+| Open Hands       | `.openhands/microagents/repo.md`                 | `.openhands/config.toml`                            |
+| Gemini CLI       | `GEMINI.md`                                      | `.gemini/settings.json`                             |
+| Junie            | `.junie/guidelines.md`                           | -                                                   |
+| AugmentCode      | `.augment/rules/ruler_augment_instructions.md`   | `.vscode/settings.json`                             |
+| Kilo Code        | `.kilocode/rules/ruler_kilocode_instructions.md` | `.kilocode/mcp.json`                                |
+| OpenCode         | `AGENTS.md`                                      | `opencode.json`, `~/.config/opencode/opencode.json` |
 
 ## Getting Started
 
@@ -83,6 +85,7 @@ npx @intellectronica/ruler apply
    - `.ruler/mcp.json`: An example MCP server configuration
 
 Additionally, you can create a global configuration to use when no local `.ruler/` directory is found:
+
 ```bash
 ruler init --global
 ```
@@ -143,18 +146,18 @@ The `apply` command looks for `.ruler/` in the current directory tree, reading t
 
 ### Options
 
-| Option                         | Description                                               |
-| ------------------------------ | --------------------------------------------------------- |
-| `--project-root <path>`        | Path to your project's root (default: current directory)  |
+| Option                         | Description                                                                                                                                                |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--project-root <path>`        | Path to your project's root (default: current directory)                                                                                                   |
 | `--agents <agent1,agent2,...>` | Comma-separated list of agent names to target (copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, augmentcode, kilocode) |
-| `--config <path>`              | Path to a custom `ruler.toml` configuration file          |
-| `--mcp` / `--with-mcp`         | Enable applying MCP server configurations (default: true) |
-| `--no-mcp`                     | Disable applying MCP server configurations                |
-| `--mcp-overwrite`              | Overwrite native MCP config entirely instead of merging   |
-| `--gitignore`                  | Enable automatic .gitignore updates (default: true)       |
-| `--no-gitignore`               | Disable automatic .gitignore updates                      |
-| `--local-only`                 | Do not look for configuration in `$XDG_CONFIG_HOME`       |
-| `--verbose` / `-v`             | Display detailed output during execution                  |
+| `--config <path>`              | Path to a custom `ruler.toml` configuration file                                                                                                           |
+| `--mcp` / `--with-mcp`         | Enable applying MCP server configurations (default: true)                                                                                                  |
+| `--no-mcp`                     | Disable applying MCP server configurations                                                                                                                 |
+| `--mcp-overwrite`              | Overwrite native MCP config entirely instead of merging                                                                                                    |
+| `--gitignore`                  | Enable automatic .gitignore updates (default: true)                                                                                                        |
+| `--no-gitignore`               | Disable automatic .gitignore updates                                                                                                                       |
+| `--local-only`                 | Do not look for configuration in `$XDG_CONFIG_HOME`                                                                                                        |
+| `--verbose` / `-v`             | Display detailed output during execution                                                                                                                   |
 
 ### Common Examples
 
@@ -201,6 +204,7 @@ The `revert` command safely undoes all changes made by `ruler apply`, restoring
 ### Why Revert is Needed
 
 When experimenting with different rule configurations or switching between projects, you may want to:
+
 - **Clean slate**: Remove all ruler-generated files to start fresh
 - **Restore originals**: Revert modified files back to their original state
 - **Selective cleanup**: Remove configurations for specific agents only
@@ -214,15 +218,15 @@ ruler revert [options]
 
 ### Options
 
-| Option                         | Description                                               |
-| ------------------------------ | --------------------------------------------------------- |
-| `--project-root <path>`        | Path to your project's root (default: current directory)  |
-| `--agents <agent1,agent2,...>` | Comma-separated list of agent names to revert (copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode) |
-| `--config <path>`              | Path to a custom `ruler.toml` configuration file          |
-| `--keep-backups`               | Keep backup files (.bak) after restoration (default: false) |
-| `--dry-run`                    | Preview changes without actually reverting files          |
-| `--verbose` / `-v`             | Display detailed output during execution                  |
-| `--local-only`                 | Only search for local .ruler directories, ignore global config |
+| Option                         | Description                                                                                                                                             |
+| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--project-root <path>`        | Path to your project's root (default: current directory)                                                                                                |
+| `--agents <agent1,agent2,...>` | Comma-separated list of agent names to revert (copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode, opencode) |
+| `--config <path>`              | Path to a custom `ruler.toml` configuration file                                                                                                        |
+| `--keep-backups`               | Keep backup files (.bak) after restoration (default: false)                                                                                             |
+| `--dry-run`                    | Preview changes without actually reverting files                                                                                                        |
+| `--verbose` / `-v`             | Display detailed output during execution                                                                                                                |
+| `--local-only`                 | Only search for local .ruler directories, ignore global config                                                                                          |
 
 ### Common Examples
 

package/dist/agents/OpenCodeAgent.js

@@ -0,0 +1,60 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenCodeAgent = void 0;
+const FileSystemUtils_1 = require("../core/FileSystemUtils");
+const path = __importStar(require("path"));
+class OpenCodeAgent {
+    getIdentifier() {
+        return 'opencode';
+    }
+    getName() {
+        return 'OpenCode';
+    }
+    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, // eslint-disable-line @typescript-eslint/no-unused-vars
+    agentConfig) {
+        const outputPath = agentConfig?.outputPath ?? this.getDefaultOutputPath(projectRoot);
+        const absolutePath = path.resolve(projectRoot, outputPath);
+        await (0, FileSystemUtils_1.backupFile)(absolutePath);
+        await (0, FileSystemUtils_1.writeGeneratedFile)(absolutePath, concatenatedRules);
+    }
+    getDefaultOutputPath(projectRoot) {
+        return path.join(projectRoot, 'AGENTS.md');
+    }
+    getMcpServerKey() {
+        return 'mcp';
+    }
+}
+exports.OpenCodeAgent = OpenCodeAgent;

package/dist/cli/commands.js

@@ -60,7 +60,7 @@ function run() {
         });
         y.option('agents', {
             type: 'string',
-            description: 'Comma-separated list of agent identifiers: copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode',
+            description: 'Comma-separated list of agent identifiers: copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode, opencode',
         });
         y.option('config', {
             type: 'string',
@@ -254,7 +254,7 @@ and apply them to your configured AI coding agents.
         });
         y.option('agents', {
             type: 'string',
-            description: 'Comma-separated list of agent identifiers: copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode',
+            description: 'Comma-separated list of agent identifiers: copilot, claude, codex, cursor, windsurf, cline, aider, firebase, gemini-cli, junie, kilocode, opencode',
         });
         y.option('config', {
             type: 'string',

package/dist/lib.js

@@ -54,10 +54,12 @@ const JulesAgent_1 = require("./agents/JulesAgent");
 const JunieAgent_1 = require("./agents/JunieAgent");
 const AugmentCodeAgent_1 = require("./agents/AugmentCodeAgent");
 const KiloCodeAgent_1 = require("./agents/KiloCodeAgent");
+const OpenCodeAgent_1 = require("./agents/OpenCodeAgent");
 const merge_1 = require("./mcp/merge");
 const validate_1 = require("./mcp/validate");
 const mcp_1 = require("./paths/mcp");
 const propagateOpenHandsMcp_1 = require("./mcp/propagateOpenHandsMcp");
+const propagateOpenCodeMcp_1 = require("./mcp/propagateOpenCodeMcp");
 const constants_1 = require("./constants");
 /**
  * Gets all output paths for an agent, taking into account any config overrides.
@@ -108,6 +110,7 @@ const agents = [
     new JunieAgent_1.JunieAgent(),
     new AugmentCodeAgent_1.AugmentCodeAgent(),
     new KiloCodeAgent_1.KiloCodeAgent(),
+    new OpenCodeAgent_1.OpenCodeAgent(),
 ];
 /**
  * Applies ruler configurations for all supported AI agents.
@@ -265,6 +268,15 @@ async function applyAllAgentConfigs(projectRoot, includedAgents, configPath, cli
                     (0, constants_1.logVerbose)(`DRY RUN: AugmentCode MCP config handled internally via VSCode settings`, verbose);
                 }
             }
+            else if (agent.getIdentifier() === 'opencode') {
+                // *** Special handling for OpenCode ***
+                if (dryRun) {
+                    (0, constants_1.logVerbose)(`DRY RUN: Would apply MCP config by updating OpenCode config file: ${dest}`, verbose);
+                }
+                else {
+                    await (0, propagateOpenCodeMcp_1.propagateMcpToOpenCode)(rulerMcpFile, dest);
+                }
+            }
             else {
                 if (rulerMcpJson) {
                     const strategy = cliMcpStrategy ??

package/dist/mcp/propagateOpenCodeMcp.js

@@ -0,0 +1,113 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propagateMcpToOpenCode = propagateMcpToOpenCode;
+const fs = __importStar(require("fs/promises"));
+const FileSystemUtils_1 = require("../core/FileSystemUtils");
+const path = __importStar(require("path"));
+/**
+ * Transform ruler MCP configuration to OpenCode's specific format
+ */
+function transformToOpenCodeFormat(rulerMcp) {
+    const rulerServers = rulerMcp.mcpServers || {};
+    const openCodeServers = {};
+    for (const [name, serverDef] of Object.entries(rulerServers)) {
+        const server = serverDef;
+        // Determine if this is a local or remote server
+        const isRemote = !!server.url;
+        const openCodeServer = {
+            type: isRemote ? 'remote' : 'local',
+            enabled: true, // Always true as per the issue requirements
+        };
+        if (isRemote) {
+            // Remote server configuration
+            openCodeServer.url = server.url;
+            if (server.headers) {
+                openCodeServer.headers = server.headers;
+            }
+        }
+        else {
+            // Local server configuration
+            if (server.command) {
+                // Combine command and args into a single array
+                const command = Array.isArray(server.command)
+                    ? server.command
+                    : [server.command];
+                const args = server.args || [];
+                openCodeServer.command = [...command, ...args];
+            }
+            if (server.env) {
+                openCodeServer.environment = server.env;
+            }
+        }
+        openCodeServers[name] = openCodeServer;
+    }
+    return {
+        $schema: 'https://opencode.ai/config.json',
+        mcp: openCodeServers,
+    };
+}
+async function propagateMcpToOpenCode(rulerMcpPath, openCodeConfigPath) {
+    let rulerMcp;
+    try {
+        const rulerJsonContent = await fs.readFile(rulerMcpPath, 'utf8');
+        rulerMcp = JSON.parse(rulerJsonContent);
+    }
+    catch {
+        return;
+    }
+    // Read existing OpenCode config if it exists
+    let existingConfig = {};
+    try {
+        const existingContent = await fs.readFile(openCodeConfigPath, 'utf8');
+        existingConfig = JSON.parse(existingContent);
+    }
+    catch {
+        // File doesn't exist, we'll create it
+    }
+    // Transform ruler MCP to OpenCode format
+    const transformedConfig = transformToOpenCodeFormat(rulerMcp);
+    // Merge with existing config, preserving non-MCP settings
+    const finalConfig = {
+        ...existingConfig,
+        $schema: transformedConfig.$schema,
+        mcp: {
+            ...existingConfig.mcp,
+            ...transformedConfig.mcp,
+        },
+    };
+    await (0, FileSystemUtils_1.ensureDirExists)(path.dirname(openCodeConfigPath));
+    await fs.writeFile(openCodeConfigPath, JSON.stringify(finalConfig, null, 2) + '\n');
+}

package/dist/paths/mcp.js

@@ -80,6 +80,10 @@ async function getNativeMcpPath(adapterName, projectRoot) {
         case 'Kilo Code':
             candidates.push(path.join(projectRoot, '.kilocode', 'mcp.json'));
             break;
+        case 'OpenCode':
+            candidates.push(path.join(projectRoot, 'opencode.json'));
+            candidates.push(path.join(home, '.config', 'opencode', 'opencode.json'));
+            break;
         default:
             return null;
     }

package/dist/revert.js

@@ -52,6 +52,7 @@ const JulesAgent_1 = require("./agents/JulesAgent");
 const JunieAgent_1 = require("./agents/JunieAgent");
 const AugmentCodeAgent_1 = require("./agents/AugmentCodeAgent");
 const KiloCodeAgent_1 = require("./agents/KiloCodeAgent");
+const OpenCodeAgent_1 = require("./agents/OpenCodeAgent");
 const mcp_1 = require("./paths/mcp");
 const constants_1 = require("./constants");
 const settings_1 = require("./vscode/settings");
@@ -70,6 +71,7 @@ const agents = [
     new JunieAgent_1.JunieAgent(),
     new AugmentCodeAgent_1.AugmentCodeAgent(),
     new KiloCodeAgent_1.KiloCodeAgent(),
+    new OpenCodeAgent_1.OpenCodeAgent(),
 ];
 /**
  * Gets all output paths for an agent, taking into account any config overrides.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellectronica/ruler",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "description": "Ruler — apply the same rules to all coding agents",
   "main": "dist/lib.js",
   "scripts": {