aicm 0.7.0 → 0.8.0

package/README.md

@@ -192,6 +192,8 @@ Example `aicm.json`:
 
   - Preset files should contain a `rules` and `mcpServers` objects with the same structure as the main configuration.
 
+- **installOnCI**: Boolean flag (default: `false`) that controls whether installation should proceed in CI environments. When set to `true`, rules will be installed even in CI environments.
+
 ### MCP Server Installation
 
 - **Cursor**: MCP server configs are written to `.cursor/mcp.json` (see Cursor docs for latest path).
@@ -247,6 +249,10 @@ Installs all rules and MCPs configured in your `aicm.json`.
 npx aicm install
 ```
 
+Options:
+
+- `--ci`: run in CI environments (default: `false`)
+
 ## Node.js API
 
 In addition to the CLI, aicm can be used programmatically in Node.js applications:
@@ -289,6 +295,7 @@ Installs rules and MCP servers based on configuration.
 
 - `cwd`: Base directory to use instead of `process.cwd()`
 - `config`: Custom config object to use instead of loading from file
+- `installOnCI`: Run installation on CI environments (default: `false`)
 
 **Returns:**
 

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 import { InstallOptions, InstallResult } from "./commands/install";
 /**
  * Install AICM rules based on configuration
- * @param options Install options
+ * @param options Installation options
  * @returns Result of the install operation
  */
 export declare function install(options?: InstallOptions): Promise<InstallResult>;

package/dist/api.js

@@ -4,7 +4,7 @@ exports.install = install;
 const install_1 = require("./commands/install");
 /**
  * Install AICM rules based on configuration
- * @param options Install options
+ * @param options Installation options
  * @returns Result of the install operation
  */
 async function install(options = {}) {

package/dist/commands/init.js

@@ -11,6 +11,7 @@ const defaultConfig = {
     ides: ["cursor"],
     rules: {},
     mcpServers: {},
+    installOnCI: false,
 };
 function initCommand() {
     const configPath = path_1.default.join(process.cwd(), "aicm.json");

package/dist/commands/install.d.ts

@@ -11,6 +11,10 @@ export interface InstallOptions {
      * Custom config object to use instead of loading from file
      */
     config?: Config;
+    /**
+     * allow installation on CI environments
+     */
+    installOnCI?: boolean;
 }
 /**
  * Result of the install operation
@@ -35,4 +39,4 @@ export interface InstallResult {
  * @returns Result of the install operation
  */
 export declare function install(options?: InstallOptions): Promise<InstallResult>;
-export declare function installCommand(): Promise<void>;
+export declare function installCommand(installOnCI?: boolean): Promise<void>;

package/dist/commands/install.js

@@ -12,6 +12,7 @@ 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"));
+const ci_info_1 = require("ci-info");
 /**
  * Write MCP servers configuration to IDE targets
  * @param mcpServers The MCP servers configuration
@@ -33,6 +34,19 @@ function writeMcpServersToTargets(mcpServers, ides, cwd) {
         }
     }
 }
+/**
+ * Checks if the current environment is a CI environment
+ * This function respects any explicit settings in process.env.CI
+ */
+function isInCIEnvironment() {
+    // Explicit environment variable settings take precedence
+    if (process.env.CI === "true")
+        return true;
+    if (process.env.CI === "false")
+        return false;
+    // Fall back to ci-info's detection
+    return ci_info_1.isCI;
+}
 /**
  * Core implementation of the rule installation logic
  * @param options Install options
@@ -40,6 +54,7 @@ function writeMcpServersToTargets(mcpServers, ides, cwd) {
  */
 async function install(options = {}) {
     const cwd = options.cwd || process.cwd();
+    const installOnCI = options.installOnCI === true; // Default to false if not specified
     try {
         const originalCwd = process.cwd();
         if (cwd !== originalCwd) {
@@ -57,6 +72,17 @@ async function install(options = {}) {
                 installedRuleCount: 0,
             };
         }
+        const inCI = isInCIEnvironment();
+        if (inCI && !installOnCI && !config.installOnCI) {
+            if (cwd !== originalCwd) {
+                process.chdir(originalCwd);
+            }
+            console.log(chalk_1.default.yellow("Detected CI environment, skipping install."));
+            return {
+                success: true,
+                installedRuleCount: 0,
+            };
+        }
         // Check if rules are defined (either directly or through presets)
         if (!config.rules || Object.keys(config.rules).length === 0) {
             // If there are no presets defined either, show a message
@@ -146,9 +172,9 @@ async function install(options = {}) {
         };
     }
 }
-async function installCommand() {
+async function installCommand(installOnCI) {
     try {
-        const result = await install();
+        const result = await install({ installOnCI });
         if (!result.success) {
             console.error(chalk_1.default.red(result.error));
             process.exit(1);

package/dist/index.js

@@ -16,6 +16,7 @@ const pkg = require("../package.json");
 const args = (0, arg_1.default)({
     "--help": Boolean,
     "--version": Boolean,
+    "--ci": Boolean,
     "-h": "--help",
     "-v": "--version",
 }, {
@@ -35,7 +36,7 @@ switch (command) {
         (0, init_1.initCommand)();
         break;
     case "install":
-        (0, install_1.installCommand)();
+        (0, install_1.installCommand)(args["--ci"]);
         break;
     case "list":
         (0, list_1.listCommand)();
@@ -60,6 +61,7 @@ ${chalk_1.default.bold("COMMANDS")}
 ${chalk_1.default.bold("OPTIONS")}
   -h, --help          Show this help message
   -v, --version       Show version number
+  --ci                Run in CI environments (default: \`false\`)
 
 ${chalk_1.default.bold("EXAMPLES")}
   $ aicm init

package/dist/types/index.d.ts

@@ -21,6 +21,7 @@ export interface Config {
     rules: Rules;
     presets?: string[];
     mcpServers?: MCPServers;
+    installOnCI?: boolean;
 }
 export interface RuleMetadata {
     type?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aicm",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "A TypeScript CLI tool for managing AI IDE rules across different projects and teams",
   "main": "dist/api.js",
   "types": "dist/api.d.ts",
@@ -41,6 +41,7 @@
     "arg": "^5.0.2",
     "args": "^5.0.3",
     "chalk": "^4.1.2",
+    "ci-info": "^4.2.0",
     "cosmiconfig": "^9.0.0",
     "fs-extra": "^11.1.1"
   },