@intellectronica/ruler 0.2.13 → 0.2.15

package/README.md

@@ -40,7 +40,7 @@ Ruler solves this by providing a **single source of truth** for all your AI agen
 | ---------------- | ------------------------------------------------ | --------------------------------------------------- |
 | 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`                              |
+| OpenAI Codex CLI | `AGENTS.md`                                      | `.codex/config.toml`, `~/.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`               |
@@ -299,6 +299,17 @@ enabled = true
 output_path_instructions = "ruler_aider_instructions.md"
 output_path_config = ".aider.conf.yml"
 
+# OpenAI Codex CLI agent and MCP config
+[agents.codex]
+enabled = true
+output_path = "AGENTS.md"
+output_path_config = ".codex/config.toml"
+
+# Agent-specific MCP configuration for Codex CLI
+[agents.codex.mcp]
+enabled = true
+merge_strategy = "merge"
+
 [agents.firebase]
 enabled = true
 output_path = ".idx/airules.md"
@@ -360,8 +371,14 @@ Define your project's MCP servers:
 }
 ```
 
+
 Ruler uses this file with the `merge` (default) or `overwrite` strategy, controlled by `ruler.toml` or CLI flags.
 
+**Note for OpenAI Codex CLI:** To apply the local Codex CLI MCP configuration, set the `CODEX_HOME` environment variable to your project’s `.codex` directory:
+```bash
+export CODEX_HOME="$(pwd)/.codex"
+```
+
 ## `.gitignore` Integration
 
 Ruler automatically manages your `.gitignore` file to keep generated agent configuration files out of version control.

package/dist/agents/CodexCliAgent.js

@@ -35,9 +35,13 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CodexCliAgent = void 0;
 const path = __importStar(require("path"));
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const fs_1 = require("fs");
+const toml = __importStar(require("toml"));
+const toml_1 = require("@iarna/toml");
 const FileSystemUtils_1 = require("../core/FileSystemUtils");
 /**
- * OpenAI Codex CLI agent adapter (stub implementation).
+ * OpenAI Codex CLI agent adapter.
  */
 class CodexCliAgent {
     getIdentifier() {
@@ -46,14 +50,107 @@ class CodexCliAgent {
     getName() {
         return 'OpenAI Codex CLI';
     }
-    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, // eslint-disable-line @typescript-eslint/no-unused-vars
-    agentConfig) {
-        const output = agentConfig?.outputPath ?? this.getDefaultOutputPath(projectRoot);
-        await (0, FileSystemUtils_1.backupFile)(output);
-        await (0, FileSystemUtils_1.writeGeneratedFile)(output, concatenatedRules);
+    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, agentConfig) {
+        // Get default paths
+        const defaults = this.getDefaultOutputPath(projectRoot);
+        // Determine the instructions file path
+        const instructionsPath = agentConfig?.outputPath ??
+            agentConfig?.outputPathInstructions ??
+            defaults.instructions;
+        // Write the instructions file
+        await (0, FileSystemUtils_1.backupFile)(instructionsPath);
+        await (0, FileSystemUtils_1.writeGeneratedFile)(instructionsPath, concatenatedRules);
+        // Handle MCP configuration if enabled
+        const mcpEnabled = agentConfig?.mcp?.enabled ?? true;
+        if (mcpEnabled && rulerMcpJson) {
+            // Determine the config file path
+            const configPath = agentConfig?.outputPathConfig ?? defaults.config;
+            // Ensure the parent directory exists
+            await fs_1.promises.mkdir(path.dirname(configPath), { recursive: true });
+            // Get the merge strategy
+            const strategy = agentConfig?.mcp?.strategy ?? 'merge';
+            // Extract MCP servers from ruler config
+            const rulerServers = rulerMcpJson.mcpServers || {};
+            // Read existing TOML config if it exists
+            let existingConfig = {};
+            try {
+                const existingContent = await fs_1.promises.readFile(configPath, 'utf8');
+                existingConfig = toml.parse(existingContent);
+            }
+            catch {
+                // File doesn't exist or can't be parsed, use empty config
+            }
+            // Create the updated config
+            const updatedConfig = { ...existingConfig };
+            // Initialize mcp_servers if it doesn't exist
+            if (!updatedConfig.mcp_servers) {
+                updatedConfig.mcp_servers = {};
+            }
+            if (strategy === 'overwrite') {
+                // For overwrite strategy, replace the entire mcp_servers section
+                updatedConfig.mcp_servers = {};
+            }
+            // Add the ruler servers
+            for (const [serverName, serverConfig] of Object.entries(rulerServers)) {
+                // Create a properly formatted MCP server entry
+                const mcpServer = {
+                    command: serverConfig.command,
+                    args: serverConfig.args,
+                };
+                // Format env as an inline table
+                if (serverConfig.env) {
+                    mcpServer.env = serverConfig.env;
+                }
+                updatedConfig.mcp_servers[serverName] = mcpServer;
+            }
+            // Convert to TOML with special handling for env to ensure it's an inline table
+            let tomlContent = '';
+            // Handle non-mcp_servers sections first
+            const configWithoutMcpServers = { ...updatedConfig };
+            delete configWithoutMcpServers.mcp_servers;
+            if (Object.keys(configWithoutMcpServers).length > 0) {
+                tomlContent += (0, toml_1.stringify)(configWithoutMcpServers);
+            }
+            // Now handle mcp_servers with special formatting for env
+            if (updatedConfig.mcp_servers &&
+                Object.keys(updatedConfig.mcp_servers).length > 0) {
+                for (const [serverName, serverConfigRaw] of Object.entries(updatedConfig.mcp_servers)) {
+                    const serverConfig = serverConfigRaw;
+                    tomlContent += `\n[mcp_servers.${serverName}]\n`;
+                    // Add command
+                    if (serverConfig.command) {
+                        tomlContent += `command = "${serverConfig.command}"\n`;
+                    }
+                    // Add args if present
+                    if (serverConfig.args && Array.isArray(serverConfig.args)) {
+                        const argsStr = JSON.stringify(serverConfig.args)
+                            .replace(/"/g, '"')
+                            .replace(/,/g, ', ');
+                        tomlContent += `args = ${argsStr}\n`;
+                    }
+                    // Add env as inline table if present
+                    if (serverConfig.env && Object.keys(serverConfig.env).length > 0) {
+                        tomlContent += `env = { `;
+                        const entries = Object.entries(serverConfig.env);
+                        for (let i = 0; i < entries.length; i++) {
+                            const [key, value] = entries[i];
+                            tomlContent += `${key} = "${value}"`;
+                            if (i < entries.length - 1) {
+                                tomlContent += ', ';
+                            }
+                        }
+                        tomlContent += ` }\n`;
+                    }
+                }
+            }
+            await (0, FileSystemUtils_1.writeGeneratedFile)(configPath, tomlContent);
+        }
     }
     getDefaultOutputPath(projectRoot) {
-        return path.join(projectRoot, 'AGENTS.md');
+        return {
+            instructions: path.join(projectRoot, 'AGENTS.md'),
+            config: path.join(projectRoot, '.codex', 'config.toml'),
+        };
     }
 }
 exports.CodexCliAgent = CodexCliAgent;

package/dist/core/ConfigLoader.js

@@ -32,15 +32,12 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfig = loadConfig;
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
-const toml_1 = __importDefault(require("@iarna/toml"));
+const TOML = __importStar(require("toml"));
 const zod_1 = require("zod");
 const constants_1 = require("../constants");
 const mcpConfigSchema = zod_1.z
@@ -99,7 +96,7 @@ async function loadConfig(options) {
     let raw = {};
     try {
         const text = await fs_1.promises.readFile(configFile, 'utf8');
-        raw = text.trim() ? toml_1.default.parse(text) : {};
+        raw = text.trim() ? TOML.parse(text) : {};
         // Validate the configuration with zod
         const validationResult = rulerConfigSchema.safeParse(raw);
         if (!validationResult.success) {

package/dist/lib.js

@@ -59,6 +59,7 @@ 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.
@@ -267,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/mcp/propagateOpenHandsMcp.js

@@ -32,13 +32,11 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.propagateMcpToOpenHands = propagateMcpToOpenHands;
 const fs = __importStar(require("fs/promises"));
-const toml_1 = __importDefault(require("@iarna/toml"));
+const TOML = __importStar(require("toml"));
+const toml_1 = require("@iarna/toml");
 const FileSystemUtils_1 = require("../core/FileSystemUtils");
 const path = __importStar(require("path"));
 async function propagateMcpToOpenHands(rulerMcpPath, openHandsConfigPath) {
@@ -54,7 +52,7 @@ async function propagateMcpToOpenHands(rulerMcpPath, openHandsConfigPath) {
     let config = {};
     try {
         const tomlContent = await fs.readFile(openHandsConfigPath, 'utf8');
-        config = toml_1.default.parse(tomlContent);
+        config = TOML.parse(tomlContent);
     }
     catch {
         // File doesn't exist, we'll create it.
@@ -79,5 +77,5 @@ async function propagateMcpToOpenHands(rulerMcpPath, openHandsConfigPath) {
     }
     config.mcp.stdio_servers = Array.from(existingServers.values());
     await (0, FileSystemUtils_1.ensureDirExists)(path.dirname(openHandsConfigPath));
-    await fs.writeFile(openHandsConfigPath, toml_1.default.stringify(config));
+    await fs.writeFile(openHandsConfigPath, (0, toml_1.stringify)(config));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellectronica/ruler",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "description": "Ruler — apply the same rules to all coding agents",
   "main": "dist/lib.js",
   "scripts": {
@@ -61,6 +61,7 @@
   "dependencies": {
     "@iarna/toml": "^2.2.5",
     "js-yaml": "^4.1.0",
+    "toml": "^3.0.0",
     "yargs": "^17.7.2",
     "zod": "^3.25.28"
   }