@geolonia/geonicdb-cli 0.2.0 → 0.3.0

package/README.md

@@ -77,6 +77,7 @@ geonic entities list --help
 | `-f, --format <fmt>` | Output format: `json`, `table`, `geojson` |
 | `--no-color` | Disable color output |
 | `-v, --verbose` | Verbose output |
+| `--dry-run` | Print the equivalent `curl` command without executing |
 
 Options are resolved in this order (first wins):
 
@@ -388,6 +389,31 @@ Specify the output format with `--format` or `geonic config set format <fmt>`.
 
 Use `--key-values` on `entities list` and `entities get` to request simplified key-value format from the API.
 
+## Dry Run
+
+Use `--dry-run` on any command to print the equivalent `curl` command instead of executing the request. The output can be copied and run directly in a terminal.
+
+```bash
+$ geonic entities list --type Sensor --dry-run
+curl \
+  -H 'Content-Type: application/ld+json' \
+  -H 'Accept: application/ld+json' \
+  -H 'Authorization: Bearer <token>' \
+  'http://localhost:3000/ngsi-ld/v1/entities?type=Sensor'
+```
+
+Works with all operations including POST with body:
+
+```bash
+$ geonic entities create '{"id":"Room1","type":"Room"}' --dry-run
+curl \
+  -X POST \
+  -H 'Content-Type: application/ld+json' \
+  -H 'Accept: application/ld+json' \
+  -d '{"id":"Room1","type":"Room"}' \
+  'http://localhost:3000/ngsi-ld/v1/entities'
+```
+
 ## Configuration
 
 The CLI stores configuration in `~/.config/geonic/config.json`.

package/dist/index.js

@@ -585,6 +585,12 @@ function registerConfigCommand(program2) {
 import { Command } from "commander";
 
 // src/client.ts
+var DryRunSignal = class extends Error {
+  constructor() {
+    super("dry-run");
+    this.name = "DryRunSignal";
+  }
+};
 var GdbClient = class _GdbClient {
   baseUrl;
   service;
@@ -593,6 +599,7 @@ var GdbClient = class _GdbClient {
   apiKey;
   onTokenRefresh;
   verbose;
+  dryRun;
   refreshPromise;
   constructor(options) {
     this.baseUrl = options.baseUrl.replace(/\/+$/, "");
@@ -602,6 +609,7 @@ var GdbClient = class _GdbClient {
     this.apiKey = options.apiKey;
     this.onTokenRefresh = options.onTokenRefresh;
     this.verbose = options.verbose ?? false;
+    this.dryRun = options.dryRun ?? false;
   }
   buildHeaders(extra) {
     const headers = {};
@@ -682,6 +690,28 @@ var GdbClient = class _GdbClient {
     });
     process.stderr.write("\n");
   }
+  static shellQuote(value) {
+    return `'${value.split("'").join(`'"'"'`)}'`;
+  }
+  static buildCurlCommand(method, url, headers, body) {
+    const parts = ["curl"];
+    if (method !== "GET") {
+      parts.push(`-X ${method}`);
+    }
+    for (const [key, value] of Object.entries(headers)) {
+      parts.push(`-H ${_GdbClient.shellQuote(`${key}: ${value}`)}`);
+    }
+    if (body) {
+      parts.push(`-d ${_GdbClient.shellQuote(body)}`);
+    }
+    parts.push(_GdbClient.shellQuote(url));
+    return parts.join(" \\\n  ");
+  }
+  handleDryRun(method, url, headers, body) {
+    if (!this.dryRun) return;
+    console.log(_GdbClient.buildCurlCommand(method, url, headers, body));
+    throw new DryRunSignal();
+  }
   canRefresh() {
     return !!this.refreshToken && !this.apiKey;
   }
@@ -721,6 +751,7 @@ var GdbClient = class _GdbClient {
     const headers = this.buildHeaders(options?.headers);
     const body = options?.body ? JSON.stringify(options.body) : void 0;
     this.logRequest(method, url, headers, body);
+    this.handleDryRun(method, url, headers, body);
     const response = await fetch(url, { method, headers, body });
     this.logResponse(response);
     const countHeader = response.headers.get("NGSILD-Results-Count");
@@ -745,6 +776,7 @@ var GdbClient = class _GdbClient {
     const headers = this.buildHeaders(options?.headers);
     const body = options?.body ? JSON.stringify(options.body) : void 0;
     this.logRequest(method, url, headers, body);
+    this.handleDryRun(method, url, headers, body);
     const response = await fetch(url, { method, headers, body });
     this.logResponse(response);
     let data;
@@ -826,7 +858,8 @@ function resolveOptions(cmd) {
     color: opts.color,
     verbose: opts.verbose,
     profile: opts.profile,
-    apiKey: opts.apiKey ?? process.env.GDB_API_KEY ?? config.apiKey
+    apiKey: opts.apiKey ?? process.env.GDB_API_KEY ?? config.apiKey,
+    dryRun: opts.dryRun
   };
 }
 function createClient(cmd) {
@@ -851,7 +884,8 @@ function createClient(cmd) {
       if (refreshToken) cfg.refreshToken = refreshToken;
       saveConfig(cfg, opts.profile);
     },
-    verbose: opts.verbose
+    verbose: opts.verbose,
+    dryRun: opts.dryRun
   });
 }
 function getFormat(cmd) {
@@ -871,6 +905,9 @@ function withErrorHandler(fn) {
     try {
       await fn(...args);
     } catch (err) {
+      if (err instanceof DryRunSignal) {
+        return;
+      }
       if (err instanceof GdbClientError && err.status === 401) {
         printError("Authentication failed. Please run `geonic login` to re-authenticate.");
       } else if (err instanceof Error) {
@@ -3379,7 +3416,7 @@ function createProgram() {
   const require2 = createRequire3(import.meta.url);
   const pkg = require2("../package.json");
   const program2 = new Command2();
-  program2.name("geonic").description(pkg.description).option("-u, --url <url>", "Base URL of the GeonicDB server").option("-s, --service <name>", "NGSILD-Tenant header").option("--token <token>", "Authentication token").option("-p, --profile <name>", "Use a named profile").option("--api-key <key>", "API key for authentication").option("-f, --format <fmt>", "Output format: json, table, geojson").option("--no-color", "Disable color output").option("-v, --verbose", "Verbose output");
+  program2.name("geonic").description(pkg.description).option("-u, --url <url>", "Base URL of the GeonicDB server").option("-s, --service <name>", "NGSILD-Tenant header").option("--token <token>", "Authentication token").option("-p, --profile <name>", "Use a named profile").option("--api-key <key>", "API key for authentication").option("-f, --format <fmt>", "Output format: json, table, geojson").option("--no-color", "Disable color output").option("-v, --verbose", "Verbose output").option("--dry-run", "Print the equivalent curl command without executing");
   registerHelpCommand(program2);
   registerConfigCommand(program2);
   registerAuthCommands(program2);