aicm 0.1.0 → 0.4.0

package/README.md

@@ -1,6 +1,8 @@
-# 📜 rules-manager
+# 🗂️ aicm
 
-A CLI tool for syncing AI IDE rules across projects
+> Agentic IDE Configuration Manager
+
+A CLI tool for syncing and managing Agentic IDE rules across projects
 
 ## Why
 
@@ -10,9 +12,9 @@ Development teams struggle with:
 - **Knowledge Silos**: Best practices remain trapped in individual projects
 - **Change Management**: No efficient way to update and distribute new standards
 
-As developers increasingly adopt AI-powered IDEs like Cursor and Windsurf, we have an opportunity to enforce best practices through "rules." However, these rules are typically isolated within individual developers or projects.
+As developers increasingly adopt AI-powered IDEs like Cursor and Windsurf, we have an opportunity to enforce best practices through rules. However, these rules are typically isolated within individual developers or projects.
 
-**rules-manager** is a CLI tool that helps streamline rule management:
+**aicm** is a CLI tool that helps with distribution of agentic IDE configurations, rules and mcps:
 
 - 🏛️ **Single Source of Truth**: Define, maintain and version-control all AI IDE rules in one central repository
 - 📦 **Seamless Distribution**: Automatically synchronize the latest rules to developers' local projects using npm packages
@@ -22,7 +24,7 @@ As developers increasingly adopt AI-powered IDEs like Cursor and Windsurf, we ha
 
 To get automatic rule updates from NPM Packages, you can create, publish, and use dedicated npm packages to distribute AI rules across multiple projects.
 
-Considering the following npm package:
+Consider the following npm package structure:
 
 ```
 @myteam/ai-tools
@@ -35,7 +37,7 @@ Considering the following npm package:
 
 1. **Point to the path within the npm package**
 
-In your project's `rules.json`, reference the package and the specific rule:
+In your project's `aicm.json`, reference the package and the specific rule:
 
 ```json
 {
@@ -53,7 +55,7 @@ In your project's `rules.json`, reference the package and the specific rule:
 ```json
 {
   "scripts": {
-    "postinstall": "npx -y rules-manager install"
+    "postinstall": "npx -y aicm install"
   }
 }
 ```
@@ -79,32 +81,32 @@ Create a JSON file with your rule definitions:
 
 2. **Reference the preset in your project**
 
-In your project's `rules.json`, reference the preset:
+In your project's `aicm.json`, reference the preset:
 
 ```json
 {
   "ides": ["cursor"],
-  "presets": ["@myteam/ai-tools/my-rule.json"]
+  "presets": ["@myteam/ai-tools/my-aicm.json"]
 }
 ```
 
-When you run `npx rules-manager install`, all rules from the preset will be installed to `.cursor/rules/`.
+When you run `npx aicm install`, all rules from the preset will be installed to `.cursor/rules/`.
 
 ### Demo
 
-Here is a package to demonstrate how rules manager works:
+Here is a package to demonstrate how aicm works:
 
 ```bash
 # Install a package containing a rule
 npm install --save-dev pirate-coding-rule
 
-# Install the rule via the rules-manager CLI
-npx -y rules-manager install pirate-coding pirate-coding-rule/rule.mdc
+# Install the rule via the aicm CLI
+npx -y aicm install pirate-coding pirate-coding-rule/rule.mdc
 ```
 
 This command will:
 
-1. Create a `rules.json` file if it doesn't exist
+1. Create a `aicm.json` file if it doesn't exist
 2. Add the rule to the configuration
 3. Install the rule to `.cursor/rules/`
 
@@ -116,14 +118,24 @@ To prevent [prompt-injection](https://en.wikipedia.org/wiki/Prompt_injection), u
 
 ## Configuration
 
-rules-manager uses a JSON configuration file (`rules.json`) in your project root directory.
+To configure aicm, use either:
+
+- a root-level `aicm.json` file, **or**
+- an `aicm` key in your project's `package.json`.
+
+Example `aicm.json`:
 
 ```json
 {
   "ides": ["cursor"],
-  "presets": ["@my-team/ai-tools/my-rules.json"],
+  "presets": ["@my-team/ai-tools/my-aicm.json"],
   "rules": {
     "team-standards": "@my-team/ai-tools/rules/team-standards.mdc"
+  },
+  "mcpServers": {
+    "remote-mcp": {
+      "url": "https://example.com/mcp-config.json"
+    }
   }
 }
 ```
@@ -137,9 +149,20 @@ rules-manager uses a JSON configuration file (`rules.json`) in your project root
   - **rule-name**: A unique identifier for the rule
   - **source-location**: Location of the rule file (path within an npm package or local path)
 
-- **presets**: Array of preset configurations to include. Each preset is a path to a JSON file (npm package or local path) that contains additional rules.
-  - Presets allow organizations to bundle a set of rules that can be easily shared across projects
-  - Preset files should contain a `rules` object with the same structure as the main configuration
+- **mcpServers**: Object containing MCP server configurations. Each key is a unique server name, and the value is an object with either:
+
+  - **command**: The command or script to run (with optional **args** and **env**), or
+  - **url**: The URL to fetch the MCP config from (with optional **env**)
+
+- **presets**: Array of preset configurations to include. Each preset is a path to a JSON file (npm package or local path) that contains additional rules and mcpServers.
+
+  - Preset files should contain a `rules` and `mcpServers` objects with the same structure as the main configuration.
+
+### MCP Server Installation
+
+- **Cursor**: MCP server configs are written to `.cursor/mcp.json` (see Cursor docs for latest path).
+- **Windsurf**: Windsurf does not support project mcpServers. MCP server configuration is not installed for Windsurf projects.
+- All installations are per-project.
 
 ### Rule Source Types
 
@@ -150,7 +173,7 @@ The type of rule is automatically detected based on the source format:
 Rules provided by NPM packages. The package must be installed either globally or in your project's `node_modules`. Sources that start with `@` or don't contain start with path separators are detected as NPM packages.
 
 ```json
-"react-best-practices": "@my-team/ai-tools/rules-manager-react"
+"react-best-practices": "@my-team/ai-tools/aicm-react"
 ```
 
 #### Local Source
@@ -163,8 +186,8 @@ Rules stored locally in your project or filesystem. Any path containing slashes
 
 ## Supported IDEs
 
-- **Cursor**: Rules are installed as individual `.mdc` files in the Cursor rules directory (`.cursor/rules/`)
-- **Windsurf**: Rules are installed in the `.rules` directory which should be added to your `.gitignore` file. Our approach for Windsurf is to create links from the `.windsurfrules` file to the respective rules in the `.rules` directory.
+- **Cursor**: Rules are installed as individual `.mdc` files in the Cursor rules directory (`.cursor/rules/`), mcp servers are installed to `.cursor/mcp.json`
+- **Windsurf**: Rules are installed in the `.rules` directory which should be added to your `.gitignore` file. Our approach for Windsurf is to create links from the `.windsurfrules` file to the respective rules in the `.rules` directory. There is no support for local mcp servers at the moment.
 
 ## Commands
 
@@ -180,7 +203,7 @@ These options are available for all commands:
 Initializes a new configuration file in your current directory.
 
 ```bash
-npx rules-manager init
+npx aicm init
 ```
 
 ### `install`
@@ -188,7 +211,7 @@ npx rules-manager init
 Installs rules from your configuration to the appropriate IDE locations.
 
 ```bash
-npx rules-manager install [rule-name] [rule-source]
+npx aicm install [rule-name] [rule-source]
 ```
 
 **Options:**
@@ -200,10 +223,10 @@ npx rules-manager install [rule-name] [rule-source]
 
 ```bash
 # Install all configured rules
-npx -y rules-manager install
+npx -y aicm install
 
 # Install a rule from an npm package and update configuration
-npx -y rules-manager install react-best-practices @my-team/ai-tools/react-best-practices.mdc
+npx -y aicm install react-best-practices @my-team/ai-tools/react-best-practices.mdc
 ```
 
 ## Contributing
@@ -226,7 +249,3 @@ npm run test:unit
 # Run only E2E tests
 npm run test:e2e
 ```
-
-## License
-
-MIT

package/dist/commands/init.js

@@ -10,9 +10,10 @@ const chalk_1 = __importDefault(require("chalk"));
 const defaultConfig = {
     ides: ["cursor"],
     rules: {},
+    mcpServers: {},
 };
 function initCommand() {
-    const configPath = path_1.default.join(process.cwd(), "rules.json");
+    const configPath = path_1.default.join(process.cwd(), "aicm.json");
     if (fs_extra_1.default.existsSync(configPath)) {
         console.log(chalk_1.default.yellow("Configuration file already exists!"));
         return;
@@ -22,8 +23,8 @@ function initCommand() {
         console.log(chalk_1.default.green("Configuration file created successfully!"));
         console.log(`Configuration file location: ${chalk_1.default.blue(configPath)}`);
         console.log(`\nNext steps:`);
-        console.log(`  1. Edit ${chalk_1.default.blue("rules.json")} to configure your rules`);
-        console.log(`  2. Run ${chalk_1.default.blue("npx rules-manager install")} to install rules`);
+        console.log(`  1. Edit ${chalk_1.default.blue("aicm.json")} to configure your rules`);
+        console.log(`  2. Run ${chalk_1.default.blue("npx aicm install")} to install rules`);
     }
     catch (error) {
         console.error(chalk_1.default.red("Error creating configuration file:"), error);

package/dist/commands/install.js

@@ -10,12 +10,29 @@ const config_1 = require("../utils/config");
 const rule_detector_1 = require("../utils/rule-detector");
 const rule_collector_1 = require("../utils/rule-collector");
 const rule_writer_1 = require("../utils/rule-writer");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const node_path_1 = __importDefault(require("node:path"));
 // Default configuration
 const defaultConfig = {
     ides: ["cursor", "windsurf"],
     rules: {},
     presets: [],
 };
+function writeMcpServersToTargets(mcpServers, ides) {
+    if (!mcpServers)
+        return;
+    for (const ide of ides) {
+        let mcpPath = null;
+        if (ide === "cursor") {
+            mcpPath = node_path_1.default.join(process.cwd(), ".cursor", "mcp.json");
+            fs_extra_1.default.ensureDirSync(node_path_1.default.dirname(mcpPath));
+        }
+        // Windsurf does not support project mcpServers, so skip
+        if (mcpPath) {
+            fs_extra_1.default.writeJsonSync(mcpPath, { mcpServers }, { spaces: 2 });
+        }
+    }
+}
 async function installCommand() {
     // Parse command-specific arguments
     const args = (0, arg_1.default)({
@@ -62,6 +79,8 @@ async function installCommand() {
             (0, rule_collector_1.addRuleToCollection)(ruleCollection, ruleContent, config.ides);
             // Write rules to targets
             (0, rule_writer_1.writeRulesToTargets)(ruleCollection);
+            // Write mcpServers config to IDE targets
+            writeMcpServersToTargets(config.mcpServers, config.ides);
             console.log(chalk_1.default.green("\nRules installation completed!"));
             return;
         }
@@ -74,7 +93,7 @@ async function installCommand() {
             (0, config_1.saveConfig)(config);
             console.log(chalk_1.default.green("Empty configuration file created successfully!"));
             console.log(chalk_1.default.yellow("No rules defined in configuration."));
-            console.log(`Edit your ${chalk_1.default.blue("rules.json")} file to add rules or use the direct install command: npx rules-manager install <rule-name> <rule-source>`);
+            console.log(`Edit your ${chalk_1.default.blue("aicm.json")} file to add rules or use the direct install command: npx aicm install <rule-name> <rule-source>`);
             return;
         }
         // Check if rules are defined (either directly or through presets)
@@ -82,7 +101,7 @@ async function installCommand() {
             // If there are no presets defined either, show a message
             if (!config.presets || config.presets.length === 0) {
                 console.log(chalk_1.default.yellow("No rules defined in configuration."));
-                console.log(`Edit your ${chalk_1.default.blue("rules.json")} file to add rules or use the direct install command: npx rules-manager install <rule-name> <rule-source>`);
+                console.log(`Edit your ${chalk_1.default.blue("aicm.json")} file to add rules or use the direct install command: npx aicm install <rule-name> <rule-source>`);
                 return;
             }
         }
@@ -143,6 +162,8 @@ async function installCommand() {
         }
         // Write all collected rules to their targets
         (0, rule_writer_1.writeRulesToTargets)(ruleCollection);
+        // Write mcpServers config to IDE targets
+        writeMcpServersToTargets(config.mcpServers, config.ides);
         console.log(chalk_1.default.green("\nRules installation completed!"));
     }
     catch (error) {

package/dist/commands/list.js

@@ -12,12 +12,12 @@ function listCommand() {
     const config = (0, config_1.getConfig)();
     if (!config) {
         console.log(chalk_1.default.red("Configuration file not found!"));
-        console.log(`Run ${chalk_1.default.blue("npx rules-manager init")} to create one.`);
+        console.log(`Run ${chalk_1.default.blue("npx aicm init")} to create one.`);
         return;
     }
     if (!config.rules || Object.keys(config.rules).length === 0) {
         console.log(chalk_1.default.yellow("No rules defined in configuration."));
-        console.log(`Edit your ${chalk_1.default.blue("rules.json")} file to add rules.`);
+        console.log(`Edit your ${chalk_1.default.blue("aicm.json")} file to add rules.`);
         return;
     }
     console.log(chalk_1.default.blue("Configured Rules:"));

package/dist/index.js

@@ -47,13 +47,13 @@ switch (command) {
 }
 function showHelp() {
     console.log(`
-${chalk_1.default.bold("rules-manager")} - A CLI tool for managing AI IDE rules
+${chalk_1.default.bold("aicm")} - A CLI tool for managing AI IDE configurations
 
 ${chalk_1.default.bold("USAGE")}
-  $ rules-manager [command] [options]
+  $ aicm [command] [options]
 
 ${chalk_1.default.bold("COMMANDS")}
-  init                Initialize a new rules-manager configuration file
+  init                Initialize a new aicm configuration file
   install             Install rules from configured sources
   list                List all configured rules and their status
 
@@ -62,8 +62,8 @@ ${chalk_1.default.bold("OPTIONS")}
   -v, --version       Show version number
 
 ${chalk_1.default.bold("EXAMPLES")}
-  $ rules-manager init
-  $ rules-manager install
-  $ rules-manager list
+  $ aicm init
+  $ aicm install
+  $ aicm list
 `);
 }

package/dist/types/index.d.ts

@@ -2,10 +2,25 @@ export type Rule = string;
 export interface Rules {
     [ruleName: string]: Rule;
 }
+export type MCPServer = {
+    command: string;
+    args?: string[];
+    env?: Record<string, string>;
+    url?: never;
+} | {
+    url: string;
+    env?: Record<string, string>;
+    command?: never;
+    args?: never;
+};
+export interface MCPServers {
+    [serverName: string]: MCPServer;
+}
 export interface Config {
     ides: string[];
     rules: Rules;
     presets?: string[];
+    mcpServers?: MCPServers;
 }
 export interface RuleMetadata {
     type?: string;

package/dist/utils/config.d.ts

@@ -1,14 +1,25 @@
 import { Config, Rules } from "../types";
+interface ConfigWithMeta extends Config {
+    __ruleSources?: Record<string, string>;
+}
 /**
  * Get the full path to a preset file
  */
 export declare function getFullPresetPath(presetPath: string): string | null;
 /**
- * Load a preset file and return its rules
+ * Load a preset file and return its rules and mcpServers
  */
-export declare function loadPreset(presetPath: string): Rules | null;
+export declare function loadPreset(presetPath: string): {
+    rules: Rules;
+    mcpServers?: import("../types").MCPServers;
+} | null;
 /**
- * Get the configuration from the rules.json file and merge with any presets
+ * Load the aicm config using cosmiconfigSync, supporting both aicm.json and package.json.
+ * Returns the config object or null if not found.
+ */
+export declare function loadAicmConfigCosmiconfig(): ConfigWithMeta | null;
+/**
+ * Get the configuration from aicm.json or package.json (using cosmiconfigSync) and merge with any presets
  */
 export declare function getConfig(): Config | null;
 /**
@@ -16,6 +27,7 @@ export declare function getConfig(): Config | null;
  */
 export declare function getRuleSource(config: Config, ruleName: string): string | undefined;
 /**
- * Save the configuration to the rules.json file
+ * Save the configuration to the aicm.json file
  */
 export declare function saveConfig(config: Config): boolean;
+export {};

package/dist/utils/config.js

@@ -5,13 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFullPresetPath = getFullPresetPath;
 exports.loadPreset = loadPreset;
+exports.loadAicmConfigCosmiconfig = loadAicmConfigCosmiconfig;
 exports.getConfig = getConfig;
 exports.getRuleSource = getRuleSource;
 exports.saveConfig = saveConfig;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const node_path_1 = __importDefault(require("node:path"));
 const rule_detector_1 = require("./rule-detector");
-const CONFIG_FILE = "rules.json";
+const cosmiconfig_1 = require("cosmiconfig");
+const CONFIG_FILE = "aicm.json";
 /**
  * Get the full path to a preset file
  */
@@ -46,7 +48,7 @@ function getFullPresetPath(presetPath) {
     }
 }
 /**
- * Load a preset file and return its rules
+ * Load a preset file and return its rules and mcpServers
  */
 function loadPreset(presetPath) {
     const fullPresetPath = getFullPresetPath(presetPath);
@@ -65,45 +67,26 @@ function loadPreset(presetPath) {
     if (!preset.rules || typeof preset.rules !== "object") {
         throw new Error(`Error loading preset: Invalid format in ${presetPath} - missing or invalid 'rules' object`);
     }
-    return preset.rules;
+    return { rules: preset.rules, mcpServers: preset.mcpServers };
 }
 /**
- * Read the raw configuration file without processing presets
- */
-function readConfigFile() {
-    const configPath = node_path_1.default.join(process.cwd(), CONFIG_FILE);
-    if (!fs_extra_1.default.existsSync(configPath)) {
-        return null;
-    }
-    try {
-        const configContent = fs_extra_1.default.readFileSync(configPath, "utf8");
-        const config = JSON.parse(configContent);
-        // Initialize rules object if it doesn't exist
-        if (!config.rules) {
-            config.rules = {};
-        }
-        return config;
-    }
-    catch (error) {
-        console.error("Error reading configuration file:", error);
-        return null;
-    }
-}
-/**
- * Process presets and merge their rules into the config
+ * Process presets and merge their rules and mcpServers into the config
  */
 function processPresets(config) {
     if (!config.presets || !Array.isArray(config.presets)) {
         return;
     }
     for (const presetPath of config.presets) {
-        const presetRules = loadPreset(presetPath);
-        if (!presetRules)
+        const preset = loadPreset(presetPath);
+        if (!preset)
             continue;
         const fullPresetPath = getFullPresetPath(presetPath);
         if (!fullPresetPath)
             continue;
-        mergePresetRules(config, presetRules, fullPresetPath);
+        mergePresetRules(config, preset.rules, fullPresetPath);
+        if (preset.mcpServers) {
+            mergePresetMcpServers(config, preset.mcpServers);
+        }
     }
 }
 /**
@@ -122,13 +105,46 @@ function mergePresetRules(config, presetRules, presetPath) {
     }
 }
 /**
- * Get the configuration from the rules.json file and merge with any presets
+ * Merge preset mcpServers into the config
  */
-function getConfig() {
-    const config = readConfigFile();
-    if (!config) {
+function mergePresetMcpServers(config, presetMcpServers) {
+    if (!config.mcpServers)
+        config.mcpServers = {};
+    for (const [serverName, serverConfig] of Object.entries(presetMcpServers)) {
+        if (!config.mcpServers[serverName]) {
+            config.mcpServers[serverName] = serverConfig;
+        }
+    }
+}
+/**
+ * Load the aicm config using cosmiconfigSync, supporting both aicm.json and package.json.
+ * Returns the config object or null if not found.
+ */
+function loadAicmConfigCosmiconfig() {
+    const explorer = (0, cosmiconfig_1.cosmiconfigSync)("aicm", {
+        searchPlaces: ["package.json", "aicm.json"],
+    });
+    try {
+        const result = explorer.search();
+        if (!result || !result.config)
+            return null;
+        const config = result.config;
+        if (!config.rules)
+            config.rules = {};
+        return config;
+    }
+    catch (error) {
+        console.error("Error loading aicm config via cosmiconfig:", error);
         return null;
     }
+}
+/**
+ * Get the configuration from aicm.json or package.json (using cosmiconfigSync) and merge with any presets
+ */
+function getConfig() {
+    const config = loadAicmConfigCosmiconfig();
+    if (!config)
+        return null;
     processPresets(config);
     return config;
 }
@@ -140,7 +156,7 @@ function getRuleSource(config, ruleName) {
     return (_a = config.__ruleSources) === null || _a === void 0 ? void 0 : _a[ruleName];
 }
 /**
- * Save the configuration to the rules.json file
+ * Save the configuration to the aicm.json file
  */
 function saveConfig(config) {
     const configPath = node_path_1.default.join(process.cwd(), CONFIG_FILE);

package/dist/utils/windsurf-writer.js

@@ -7,8 +7,8 @@ exports.writeWindsurfRules = writeWindsurfRules;
 exports.generateWindsurfRulesContent = generateWindsurfRulesContent;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
-const RULES_BEGIN = "<!-- RULES-MANAGER:BEGIN -->";
-const RULES_END = "<!-- RULES-MANAGER:END -->";
+const RULES_BEGIN = "<!-- AICM:BEGIN -->";
+const RULES_END = "<!-- AICM:END -->";
 const WARNING = "<!-- WARNING: Everything between these markers will be overwritten during installation -->";
 /**
  * Create a formatted block of content with rules markers

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "aicm",
-  "version": "0.1.0",
+  "version": "0.4.0",
   "description": "A TypeScript CLI tool for managing AI IDE rules across different projects and teams",
   "main": "dist/index.js",
   "bin": {
-    "rules-manager": "./dist/index.js"
+    "aicm": "./dist/index.js"
   },
   "files": [
     "dist",
@@ -40,6 +40,7 @@
     "arg": "^5.0.2",
     "args": "^5.0.3",
     "chalk": "^4.1.2",
+    "cosmiconfig": "^9.0.0",
     "fs-extra": "^11.1.1"
   },
   "devDependencies": {