groundmail-cli 0.19.0 → 0.20.0

package/dist/cli.js

@@ -69,6 +69,9 @@ async function runSendCommand(args, deps) {
       unsubscribe: options.unsubscribe
     });
     stdout(JSON.stringify(result));
+    if (result.test) {
+      stderr("Test send: simulated, nothing was delivered. Its status and webhooks are marked test.");
+    }
     return 0;
   } catch (error) {
     stderr(error instanceof Error ? error.message : String(error));
@@ -389,10 +392,16 @@ async function runListCommand(args, deps) {
   const limitRaw = readFlag7(args, "--limit");
   const cursor = readFlag7(args, "--cursor");
   const limit = limitRaw ? Number(limitRaw) : void 0;
+  if (args.includes("--test") && args.includes("--live")) {
+    stderr("Pass --test or --live, not both.");
+    return { exitCode: 1, error: "conflicting flags" };
+  }
+  const test = args.includes("--test") ? true : args.includes("--live") ? false : void 0;
   try {
     const result = await deps.listEmails({
       ...limit != null && Number.isFinite(limit) ? { limit } : {},
-      ...cursor ? { cursor } : {}
+      ...cursor ? { cursor } : {},
+      ...test !== void 0 ? { test } : {}
     });
     stdout(JSON.stringify(result));
     return { exitCode: 0 };
@@ -1288,7 +1297,7 @@ function trimUrl(value) {
 }
 
 // package.json
-var version = "0.19.0";
+var version = "0.20.0";
 
 // src/user-agent.ts
 function buildUserAgent(own) {
@@ -2146,6 +2155,7 @@ async function runCreateKeyCommandWithClient(args, env = process.env) {
   if (scopes && !scopes.ok) return { exitCode: 1, error: scopes.error };
   const domainsFlag = readFlag16(args, "--allowed-domains");
   const allowedDomains = domainsFlag?.split(/[\s,]+/).map((domain) => domain.trim()).filter(Boolean);
+  const test = args.includes("--test");
   try {
     const response = await apiRequest(baseUrl, "/api-keys", {
       apiKey,
@@ -2154,13 +2164,17 @@ async function runCreateKeyCommandWithClient(args, env = process.env) {
         ...name ? { name } : {},
         ...scope && !scopes ? { scope } : {},
         ...scopes?.ok ? { scopes: scopes.scope.split(" ") } : {},
-        ...allowedDomains?.length ? { allowed_domains: allowedDomains } : {}
+        ...allowedDomains?.length ? { allowed_domains: allowedDomains } : {},
+        ...test ? { test: true } : {}
       }
     });
     if (!response.ok) {
       return { exitCode: 1, error: errorMessage(response, "Could not create the key") };
     }
     console.log(JSON.stringify(response.body));
+    if (test) {
+      console.error("Test key: sends with it run every check and fire webhooks, but nothing is delivered. https://docs.groundmail.dev/testing");
+    }
     return { exitCode: 0 };
   } catch (error) {
     return { exitCode: 1, error: error instanceof Error ? error.message : String(error) };
@@ -3325,7 +3339,7 @@ var USAGE_LINES = [
   "  groundmail received-emails get inb_...",
   '  groundmail emails send --from you@domain.com --to user@example.com --subject "Hello" --html "<p>Hi</p>" [--category transactional|product] [--unsubscribe]',
   "  groundmail emails batch --file ./emails.json",
-  "  groundmail emails list [--limit 25] [--cursor \u2026]",
+  "  groundmail emails list [--limit 25] [--cursor \u2026] [--test | --live]",
   "  groundmail emails insights [--window 7d|30d]",
   "  groundmail emails get --id msg_\u2026",
   "  groundmail emails cancel --id msg_\u2026",
@@ -3363,7 +3377,7 @@ var USAGE_LINES = [
   '  groundmail templates duplicate --id tpl_\u2026 [--name "Copy"]',
   "  groundmail templates delete --id tpl_\u2026",
   "  groundmail keys list",
-  "  groundmail keys create [--name Default] [--scopes emails:send,domains:read] [--allowed-domains example.com]",
+  "  groundmail keys create [--name Default] [--scopes emails:send,domains:read] [--allowed-domains example.com] [--test]   --test: a gm_test_ key, sends are simulated",
   "  groundmail keys delete --id <api-key-id>",
   "  groundmail migrate sendgrid [--dry-run] [--only templates,suppressions,domains,webhooks] [--region eu]   import from SendGrid (Beta)",
   "  groundmail migrate postmark [--dry-run] [--only \u2026]   import from Postmark (Beta)",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail-cli",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Groundmail CLI — send transactional email from the terminal",
   "license": "MIT",
   "type": "module",
@@ -38,7 +38,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "groundmail": "0.16.0"
+    "groundmail": "0.17.0"
   },
   "devDependencies": {
     "tsup": "^8.5.0",