@dsmrt/axiom-cli 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @dsmrt/axiom-cli
 
+## 1.1.0
+
+### Minor Changes
+
+- b1a56bc: adding debug logging to the cli and config packages
+
+### Patch Changes
+
+- Updated dependencies [b1a56bc]
+  - @dsmrt/axiom-config@1.1.0
+
 ## 1.0.0
 
 ### Major Changes

package/dist/bin/axiom.js

@@ -28,6 +28,16 @@ var import_yargs = __toESM(require("yargs"));
 
 // src/commands/config.ts
 var import_axiom_config = require("@dsmrt/axiom-config");
+
+// src/debug.ts
+var isDebugEnabled = () => process.env.AXIOM_DEBUG === "true" || process.env.AXIOM_DEBUG === "1";
+var debug = (message, ...args) => {
+  if (isDebugEnabled()) {
+    console.error(`[axiom:cli] ${message}`, ...args);
+  }
+};
+
+// src/commands/config.ts
 var Config = class {
   command = "config";
   describe = "print the config";
@@ -38,9 +48,13 @@ var Config = class {
     return args;
   };
   handler = async (args) => {
-    console.log(JSON.stringify(await this.loadConfig(args)));
+    debug(`Config command handler called with env: ${args.env}`);
+    const config = await this.loadConfig(args);
+    debug(`Config loaded successfully, outputting as JSON`);
+    console.log(JSON.stringify(config));
   };
   loadConfig = async (args) => {
+    debug(`Loading config with env: ${args.env}`);
     return (0, import_axiom_config.loadConfig)(args);
   };
 };
@@ -215,7 +229,16 @@ Example:
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Get command handler called with env: ${args.env}, path: ${args.path}`
+    );
     const config = await (0, import_axiom_config2.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const collection = new import_axiom_aws_sdk.ParameterCollection(
       config.aws?.baseParameterPath,
       new import_client_ssm.SSMClient({
@@ -228,7 +251,9 @@ Example:
         })
       })
     );
+    debug(`Fetching parameters from SSM...`);
     const params = await collection.get();
+    debug(`Retrieved ${params.size} parameters`);
     params.forEach((parameter) => {
       console.log(
         import_chalk.default.gray(
@@ -294,30 +319,50 @@ Example: "/root/myParam" or "service/secret"`
     });
   };
   handler = async (args) => {
+    debug(
+      `Set command handler called with path: ${args.path}, secure: ${args.secure}, overwrite: ${args.overwrite}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config3.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    const fullPath = buildPath(config, args.path);
+    debug(`Full parameter path: ${fullPath}`);
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await import_inquirer2.default.prompt({
         type: "confirm",
         name: "setParam",
         message: `Are you sure you want to set '${args.path}'?`
       });
       if (!res.setParam) {
+        debug(`User declined, aborting`);
         console.log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const client = new import_client_ssm2.SSMClient({
       region: config.aws.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
+    debug(
+      `Sending parameter to SSM with type: ${args.secure ? "SecureString" : "String"}`
+    );
     const params = await client.send(
       new import_client_ssm2.PutParameterCommand({
-        Name: buildPath(config, args.path),
+        Name: fullPath,
         Value: args.value,
         Type: args.secure ? import_client_ssm2.ParameterType.SECURE_STRING : import_client_ssm2.ParameterType.STRING,
         Overwrite: args.overwrite
       })
     );
+    debug(`Parameter set successfully, version: ${params.Version}`);
     console.log(import_chalk2.default.green("Version: "), import_chalk2.default.white.bold(params.Version));
   };
 };
@@ -347,33 +392,51 @@ Example: "/root/myParam" or "service/secret"`,
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Delete command handler called with path: ${args.path}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config4.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
     const path = buildPath(args, args.path);
+    debug(`Full parameter path: ${path}`);
+    debug(
+      `Creating SSM client with region: ${config.aws?.region}, profile: ${config.aws?.profile}`
+    );
     const client = new import_client_ssm3.SSMClient({
       region: config.aws?.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
     if (path === args.aws.baseParameterPath) {
+      debug(`Delete blocked: path matches base parameter path`);
       throw new Error(
         `Deleting the path (path: ${path}) that matches the base path (awsSsmParameterPath: ${args.awsSsmParameterPath}) is prohibited.`
       );
     }
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await import_inquirer3.default.prompt({
         type: "confirm",
         name: "delete",
         message: `Are you sure you want to delete '${path}'?`
       });
       if (!res.delete) {
+        debug(`User declined, aborting`);
         log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(`Sending delete command to SSM for: ${path}`);
     await client.send(
       new import_client_ssm3.DeleteParameterCommand({
         Name: path
       })
     );
+    debug(`Parameter deleted successfully`);
     log("\u{1F44D}");
   };
 };
@@ -382,6 +445,16 @@ Example: "/root/myParam" or "service/secret"`,
 (0, import_yargs.default)(process.argv.slice(2)).env("AXIOM").scriptName("axiom").option("config", {
   alias: "c",
   string: true
+}).option("debug", {
+  alias: "d",
+  type: "boolean",
+  description: "Enable debug output",
+  default: false,
+  global: true
+}).middleware((argv) => {
+  if (argv.debug) {
+    process.env.AXIOM_DEBUG = "true";
+  }
 }).command(new Config()).command(new ParamsCommand()).strict().usage(
   `
 Axiom - an AWS focused config cli

package/dist/bin/axiom.mjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import "../chunk-72DOPOLO.mjs";
+import "../chunk-CORLQJO7.mjs";

package/dist/{chunk-72DOPOLO.mjs → chunk-CORLQJO7.mjs}

@@ -3,6 +3,16 @@ import yargs from "yargs";
 
 // src/commands/config.ts
 import { loadConfig } from "@dsmrt/axiom-config";
+
+// src/debug.ts
+var isDebugEnabled = () => process.env.AXIOM_DEBUG === "true" || process.env.AXIOM_DEBUG === "1";
+var debug = (message, ...args) => {
+  if (isDebugEnabled()) {
+    console.error(`[axiom:cli] ${message}`, ...args);
+  }
+};
+
+// src/commands/config.ts
 var Config = class {
   command = "config";
   describe = "print the config";
@@ -13,9 +23,13 @@ var Config = class {
     return args;
   };
   handler = async (args) => {
-    console.log(JSON.stringify(await this.loadConfig(args)));
+    debug(`Config command handler called with env: ${args.env}`);
+    const config = await this.loadConfig(args);
+    debug(`Config loaded successfully, outputting as JSON`);
+    console.log(JSON.stringify(config));
   };
   loadConfig = async (args) => {
+    debug(`Loading config with env: ${args.env}`);
     return loadConfig(args);
   };
 };
@@ -193,7 +207,16 @@ Example:
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Get command handler called with env: ${args.env}, path: ${args.path}`
+    );
     const config = await loadConfig2({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const collection = new ParameterCollection(
       config.aws?.baseParameterPath,
       new SSMClient({
@@ -206,7 +229,9 @@ Example:
         })
       })
     );
+    debug(`Fetching parameters from SSM...`);
     const params = await collection.get();
+    debug(`Retrieved ${params.size} parameters`);
     params.forEach((parameter) => {
       console.log(
         chalk.gray(
@@ -276,30 +301,50 @@ Example: "/root/myParam" or "service/secret"`
     });
   };
   handler = async (args) => {
+    debug(
+      `Set command handler called with path: ${args.path}, secure: ${args.secure}, overwrite: ${args.overwrite}, force: ${args.force}`
+    );
     const config = await loadConfig3({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    const fullPath = buildPath(config, args.path);
+    debug(`Full parameter path: ${fullPath}`);
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await inquirer2.prompt({
         type: "confirm",
         name: "setParam",
         message: `Are you sure you want to set '${args.path}'?`
       });
       if (!res.setParam) {
+        debug(`User declined, aborting`);
         console.log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const client = new SSMClient2({
       region: config.aws.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
+    debug(
+      `Sending parameter to SSM with type: ${args.secure ? "SecureString" : "String"}`
+    );
     const params = await client.send(
       new PutParameterCommand({
-        Name: buildPath(config, args.path),
+        Name: fullPath,
         Value: args.value,
         Type: args.secure ? ParameterType.SECURE_STRING : ParameterType.STRING,
         Overwrite: args.overwrite
       })
     );
+    debug(`Parameter set successfully, version: ${params.Version}`);
     console.log(chalk2.green("Version: "), chalk2.white.bold(params.Version));
   };
 };
@@ -329,33 +374,51 @@ Example: "/root/myParam" or "service/secret"`,
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Delete command handler called with path: ${args.path}, force: ${args.force}`
+    );
     const config = await loadConfig4({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
     const path = buildPath(args, args.path);
+    debug(`Full parameter path: ${path}`);
+    debug(
+      `Creating SSM client with region: ${config.aws?.region}, profile: ${config.aws?.profile}`
+    );
     const client = new SSMClient3({
       region: config.aws?.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
     if (path === args.aws.baseParameterPath) {
+      debug(`Delete blocked: path matches base parameter path`);
       throw new Error(
         `Deleting the path (path: ${path}) that matches the base path (awsSsmParameterPath: ${args.awsSsmParameterPath}) is prohibited.`
       );
     }
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await inquirer3.prompt({
         type: "confirm",
         name: "delete",
         message: `Are you sure you want to delete '${path}'?`
       });
       if (!res.delete) {
+        debug(`User declined, aborting`);
         log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(`Sending delete command to SSM for: ${path}`);
     await client.send(
       new DeleteParameterCommand({
         Name: path
       })
     );
+    debug(`Parameter deleted successfully`);
     log("\u{1F44D}");
   };
 };
@@ -364,6 +427,16 @@ Example: "/root/myParam" or "service/secret"`,
 yargs(process.argv.slice(2)).env("AXIOM").scriptName("axiom").option("config", {
   alias: "c",
   string: true
+}).option("debug", {
+  alias: "d",
+  type: "boolean",
+  description: "Enable debug output",
+  default: false,
+  global: true
+}).middleware((argv) => {
+  if (argv.debug) {
+    process.env.AXIOM_DEBUG = "true";
+  }
 }).command(new Config()).command(new ParamsCommand()).strict().usage(
   `
 Axiom - an AWS focused config cli

package/dist/index.js

@@ -45,6 +45,16 @@ var import_yargs = __toESM(require("yargs"));
 
 // src/commands/config.ts
 var import_axiom_config = require("@dsmrt/axiom-config");
+
+// src/debug.ts
+var isDebugEnabled = () => process.env.AXIOM_DEBUG === "true" || process.env.AXIOM_DEBUG === "1";
+var debug = (message, ...args) => {
+  if (isDebugEnabled()) {
+    console.error(`[axiom:cli] ${message}`, ...args);
+  }
+};
+
+// src/commands/config.ts
 var Config = class {
   command = "config";
   describe = "print the config";
@@ -55,9 +65,13 @@ var Config = class {
     return args;
   };
   handler = async (args) => {
-    console.log(JSON.stringify(await this.loadConfig(args)));
+    debug(`Config command handler called with env: ${args.env}`);
+    const config = await this.loadConfig(args);
+    debug(`Config loaded successfully, outputting as JSON`);
+    console.log(JSON.stringify(config));
   };
   loadConfig = async (args) => {
+    debug(`Loading config with env: ${args.env}`);
     return (0, import_axiom_config.loadConfig)(args);
   };
 };
@@ -232,7 +246,16 @@ Example:
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Get command handler called with env: ${args.env}, path: ${args.path}`
+    );
     const config = await (0, import_axiom_config2.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const collection = new import_axiom_aws_sdk.ParameterCollection(
       config.aws?.baseParameterPath,
       new import_client_ssm.SSMClient({
@@ -245,7 +268,9 @@ Example:
         })
       })
     );
+    debug(`Fetching parameters from SSM...`);
     const params = await collection.get();
+    debug(`Retrieved ${params.size} parameters`);
     params.forEach((parameter) => {
       console.log(
         import_chalk.default.gray(
@@ -311,30 +336,50 @@ Example: "/root/myParam" or "service/secret"`
     });
   };
   handler = async (args) => {
+    debug(
+      `Set command handler called with path: ${args.path}, secure: ${args.secure}, overwrite: ${args.overwrite}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config3.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
+    const fullPath = buildPath(config, args.path);
+    debug(`Full parameter path: ${fullPath}`);
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await import_inquirer2.default.prompt({
         type: "confirm",
         name: "setParam",
         message: `Are you sure you want to set '${args.path}'?`
       });
       if (!res.setParam) {
+        debug(`User declined, aborting`);
         console.log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(
+      `Creating SSM client with region: ${config.aws.region}, profile: ${config.aws.profile}`
+    );
     const client = new import_client_ssm2.SSMClient({
       region: config.aws.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
+    debug(
+      `Sending parameter to SSM with type: ${args.secure ? "SecureString" : "String"}`
+    );
     const params = await client.send(
       new import_client_ssm2.PutParameterCommand({
-        Name: buildPath(config, args.path),
+        Name: fullPath,
         Value: args.value,
         Type: args.secure ? import_client_ssm2.ParameterType.SECURE_STRING : import_client_ssm2.ParameterType.STRING,
         Overwrite: args.overwrite
       })
     );
+    debug(`Parameter set successfully, version: ${params.Version}`);
     console.log(import_chalk2.default.green("Version: "), import_chalk2.default.white.bold(params.Version));
   };
 };
@@ -364,33 +409,51 @@ Example: "/root/myParam" or "service/secret"`,
     return args;
   };
   handler = async (args) => {
+    debug(
+      `Delete command handler called with path: ${args.path}, force: ${args.force}`
+    );
     const config = await (0, import_axiom_config4.loadConfig)({ env: args.env });
+    debug(
+      `Config loaded successfully, base parameter path: ${config.aws?.baseParameterPath}`
+    );
     const path = buildPath(args, args.path);
+    debug(`Full parameter path: ${path}`);
+    debug(
+      `Creating SSM client with region: ${config.aws?.region}, profile: ${config.aws?.profile}`
+    );
     const client = new import_client_ssm3.SSMClient({
       region: config.aws?.region,
       credentials: await CachedCredentialProvider(config.aws)
     });
     if (path === args.aws.baseParameterPath) {
+      debug(`Delete blocked: path matches base parameter path`);
       throw new Error(
         `Deleting the path (path: ${path}) that matches the base path (awsSsmParameterPath: ${args.awsSsmParameterPath}) is prohibited.`
       );
     }
     if (args.force !== true) {
+      debug(`Prompting user for confirmation...`);
       const res = await import_inquirer3.default.prompt({
         type: "confirm",
         name: "delete",
         message: `Are you sure you want to delete '${path}'?`
       });
       if (!res.delete) {
+        debug(`User declined, aborting`);
         log("Doing nothing.");
         return;
       }
+      debug(`User confirmed`);
+    } else {
+      debug(`Force flag set, skipping confirmation`);
     }
+    debug(`Sending delete command to SSM for: ${path}`);
     await client.send(
       new import_client_ssm3.DeleteParameterCommand({
         Name: path
       })
     );
+    debug(`Parameter deleted successfully`);
     log("\u{1F44D}");
   };
 };
@@ -399,6 +462,16 @@ Example: "/root/myParam" or "service/secret"`,
 (0, import_yargs.default)(process.argv.slice(2)).env("AXIOM").scriptName("axiom").option("config", {
   alias: "c",
   string: true
+}).option("debug", {
+  alias: "d",
+  type: "boolean",
+  description: "Enable debug output",
+  default: false,
+  global: true
+}).middleware((argv) => {
+  if (argv.debug) {
+    process.env.AXIOM_DEBUG = "true";
+  }
 }).command(new Config()).command(new ParamsCommand()).strict().usage(
   `
 Axiom - an AWS focused config cli

package/dist/index.mjs

@@ -6,7 +6,7 @@ import {
   SetCommand,
   awsOptions,
   commonOptions
-} from "./chunk-72DOPOLO.mjs";
+} from "./chunk-CORLQJO7.mjs";
 export {
   Config,
   DeleteCommand,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsmrt/axiom-cli",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "axiom cli for managing configs including secrets",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -49,7 +49,7 @@
     "inquirer": "^8.2.6",
     "yargs": "^17.7.2",
     "@dsmrt/axiom-aws-sdk": "^1.0.0",
-    "@dsmrt/axiom-config": "^1.0.0"
+    "@dsmrt/axiom-config": "^1.1.0"
   },
   "scripts": {
     "lint": "biome lint",