@seamapi/cli 0.10.0 → 0.11.0

package/lib/util/prompt.d.ts

@@ -0,0 +1,17 @@
+import { type Answers, type Options, type PromptObject } from 'prompts';
+/**
+ * Whether the CLI can ask the user a question.
+ *
+ * Prompts read raw keypresses and render an interface, so they need a
+ * terminal on both ends: when stdin is a pipe or a file it holds request
+ * params, not answers, and when stderr is redirected nobody sees the
+ * question.
+ */
+export declare const canPrompt: () => boolean;
+/**
+ * Ask the user a question.
+ *
+ * Prompts are rendered to stderr: a selection is not a command result,
+ * so it must not end up in stdout when the CLI is piped.
+ */
+export declare const prompt: <T extends string = string>(questions: PromptObject<T> | Array<PromptObject<T>>, options?: Options) => Promise<Answers<T>>;

package/lib/util/prompt.js

@@ -0,0 +1,25 @@
+import prompts, {} from 'prompts';
+import { NonInteractiveError } from './cli-args.js';
+/**
+ * Whether the CLI can ask the user a question.
+ *
+ * Prompts read raw keypresses and render an interface, so they need a
+ * terminal on both ends: when stdin is a pipe or a file it holds request
+ * params, not answers, and when stderr is redirected nobody sees the
+ * question.
+ */
+export const canPrompt = () => process.stdin.isTTY === true && process.stderr.isTTY === true;
+/**
+ * Ask the user a question.
+ *
+ * Prompts are rendered to stderr: a selection is not a command result,
+ * so it must not end up in stdout when the CLI is piped.
+ */
+export const prompt = async (questions, options) => {
+    if (!canPrompt()) {
+        throw new NonInteractiveError('Cannot prompt without a terminal: pass the missing arguments, or pipe them in as JSON');
+    }
+    const questionList = Array.isArray(questions) ? questions : [questions];
+    return await prompts(questionList.map((question) => ({ ...question, stdout: process.stderr })), options);
+};
+//# sourceMappingURL=prompt.js.map

package/lib/util/prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../src/lib/util/prompt.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAiD,MAAM,SAAS,CAAA;AAEhF,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAEnD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,GAAY,EAAE,CACrC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EACzB,SAAmD,EACnD,OAAiB,EACI,EAAE;IACvB,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,mBAAmB,CAC3B,uFAAuF,CACxF,CAAA;IACH,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEvE,OAAO,MAAM,OAAO,CAClB,YAAY,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,EACzE,OAAO,CACR,CAAA;AACH,CAAC,CAAA"}

package/lib/util/read-stdin-json.d.ts

@@ -0,0 +1,22 @@
+import type { Readable } from 'node:stream';
+export interface StdinLike extends AsyncIterable<string | Buffer> {
+    isTTY?: boolean | undefined;
+}
+/**
+ * Read request params piped into the CLI, e.g.,
+ *
+ * ```
+ * $ echo '{"device_id": "..."}' | seam locks unlock-door --json
+ * $ seam locks unlock-door --json < params.json
+ * ```
+ *
+ * Returns null when stdin is a terminal or is empty,
+ * so an interactive session is never blocked waiting for input.
+ */
+export declare const readStdinJson: (stdin?: StdinLike | Readable) => Promise<Record<string, unknown> | null>;
+/**
+ * Parse JSON request params, e.g., from stdin or `--json '{"limit": 2}'`.
+ *
+ * Returns null when there is nothing to parse.
+ */
+export declare const parseJsonParams: (raw: string, source: string) => Record<string, unknown> | null;

package/lib/util/read-stdin-json.js

@@ -0,0 +1,42 @@
+/**
+ * Read request params piped into the CLI, e.g.,
+ *
+ * ```
+ * $ echo '{"device_id": "..."}' | seam locks unlock-door --json
+ * $ seam locks unlock-door --json < params.json
+ * ```
+ *
+ * Returns null when stdin is a terminal or is empty,
+ * so an interactive session is never blocked waiting for input.
+ */
+export const readStdinJson = async (stdin = process.stdin) => {
+    if (stdin.isTTY ?? false)
+        return null;
+    let raw = '';
+    for await (const chunk of stdin) {
+        raw += typeof chunk === 'string' ? chunk : chunk.toString('utf8');
+    }
+    return parseJsonParams(raw, 'stdin');
+};
+/**
+ * Parse JSON request params, e.g., from stdin or `--json '{"limit": 2}'`.
+ *
+ * Returns null when there is nothing to parse.
+ */
+export const parseJsonParams = (raw, source) => {
+    const trimmed = raw.trim();
+    if (trimmed === '')
+        return null;
+    let parsed;
+    try {
+        parsed = JSON.parse(trimmed);
+    }
+    catch (error) {
+        throw new Error(`Could not parse JSON from ${source}: ${error.message}`);
+    }
+    if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
+        throw new Error(`Expected a JSON object of request params from ${source}, got ${Array.isArray(parsed) ? 'an array' : typeof parsed}`);
+    }
+    return parsed;
+};
+//# sourceMappingURL=read-stdin-json.js.map

package/lib/util/read-stdin-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-stdin-json.js","sourceRoot":"","sources":["../../src/lib/util/read-stdin-json.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,QAA8B,OAAO,CAAC,KAAK,EACF,EAAE;IAC3C,IAAK,KAAmB,CAAC,KAAK,IAAI,KAAK;QAAE,OAAO,IAAI,CAAA;IAEpD,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAChC,GAAG,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnE,CAAC;IAED,OAAO,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AACtC,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,GAAW,EACX,MAAc,EACkB,EAAE;IAClC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;IAC1B,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,IAAI,CAAA;IAE/B,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,6BAA6B,MAAM,KAAM,KAAe,CAAC,OAAO,EAAE,CACnE,CAAA;IACH,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CACb,iDAAiD,MAAM,SAAS,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,MAAM,EAAE,CACrH,CAAA;IACH,CAAC;IAED,OAAO,MAAiC,CAAA;AAC1C,CAAC,CAAA"}

package/lib/util/request-seam-api.d.ts

@@ -1,4 +1,7 @@
-export declare const RequestSeamApi: ({ path, params, }: {
+export interface RequestSeamApiOptions {
     path: string;
     params: Record<string, any>;
-}) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /** Response key for the endpoint, used to trim the reported payload. */
+    responseKey?: string | null | undefined;
+}
+export declare const RequestSeamApi: ({ path, params, responseKey, }: RequestSeamApiOptions) => Promise<import("axios").AxiosResponse<any, any, {}>>;

package/lib/util/request-seam-api.js

@@ -1,28 +1,26 @@
 import chalk from 'chalk';
 import { getSeam } from '../get-seam.js';
+import { getOutput } from '../output/get-output.js';
+import { selectResponsePayload } from '../output/select-response-payload.js';
 import { withLoading } from './with-loading.js';
-export const RequestSeamApi = async ({ path, params, }) => {
+export const RequestSeamApi = async ({ path, params, responseKey, }) => {
     const seam = await getSeam();
-    logRequest(path, params);
+    const output = getOutput();
+    output.info(`\n${chalk.green(path)}`);
+    output.info(`Request Params:`);
+    output.info(formatParams(params));
     const response = await withLoading('Making request...', () => seam.client.post(path, params, {
         validateStatus: () => true,
     }));
-    logResponse(response);
-    return response;
-};
-const logResponse = (response) => {
     if (response.status >= 400) {
-        console.log(chalk.red(`\n\n[${response.status}]\n`));
+        output.warn(chalk.red(`[${response.status}]`));
+        process.exitCode = 1;
     }
     else {
-        console.log(chalk.green(`\n\n[${response.status}]`));
+        output.info(chalk.green(`[${response.status}]`));
     }
-    console.dir(response.data, { depth: null });
-    console.log('\n');
-};
-const logRequest = (apiPath, params) => {
-    console.log(`\n\n${chalk.green(apiPath)}`);
-    console.log(`Request Params:`);
-    console.log(params);
+    output.data(selectResponsePayload(response.data, { responseKey }));
+    return response;
 };
+const formatParams = (params) => JSON.stringify(params, null, 2);
 //# sourceMappingURL=request-seam-api.js.map

package/lib/util/request-seam-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-seam-api.js","sourceRoot":"","sources":["../../src/lib/util/request-seam-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,IAAI,EACJ,MAAM,GAIP,EAAE,EAAE;IACH,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAA;IAE5B,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAExB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAC3D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE;QAC7B,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;KAC3B,CAAC,CACH,CAAA;IAED,WAAW,CAAC,QAAQ,CAAC,CAAA;IAErB,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,QAA2C,EAAE,EAAE;IAClE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;IACtD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACtD,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;AACnB,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,MAA2B,EAAE,EAAE;IAClE,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC1C,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC9B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AACrB,CAAC,CAAA"}
+{"version":3,"file":"request-seam-api.js","sourceRoot":"","sources":["../../src/lib/util/request-seam-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAA;AAE7E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAS/C,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,IAAI,EACJ,MAAM,EACN,WAAW,GACW,EAAE,EAAE;IAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAA;IAC5B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAE1B,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACrC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC9B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAA;IAEjC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAC3D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE;QAC7B,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;KAC3B,CAAC,CACH,CAAA;IAED,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC9C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAA;IAElE,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,CAAC,MAA2B,EAAU,EAAE,CAC3D,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA"}

package/lib/util/with-loading.js

@@ -1,6 +1,10 @@
 import { createSpinner } from 'nanospinner';
+import { getOutput } from '../output/get-output.js';
 export const withLoading = async (message, fn) => {
-    const spinner = createSpinner(message).start();
+    if (!shouldSpin())
+        return await fn();
+    // Progress is not a command result, so it is rendered to stderr.
+    const spinner = createSpinner(message, { stream: process.stderr }).start();
     try {
         const result = await fn();
         spinner.success();
@@ -11,4 +15,5 @@ export const withLoading = async (message, fn) => {
         throw error;
     }
 };
+const shouldSpin = () => getOutput().format === 'text' && process.stderr.isTTY === true;
 //# sourceMappingURL=with-loading.js.map

package/lib/util/with-loading.js.map

@@ -1 +1 @@
-{"version":3,"file":"with-loading.js","sourceRoot":"","sources":["../../src/lib/util/with-loading.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,OAAe,EACf,EAAoB,EACR,EAAE;IACd,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAA;IAC9C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;QACzB,OAAO,CAAC,OAAO,EAAE,CAAA;QACjB,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,EAAE,CAAA;QACf,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA"}
+{"version":3,"file":"with-loading.js","sourceRoot":"","sources":["../../src/lib/util/with-loading.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,OAAe,EACf,EAAoB,EACR,EAAE;IACd,IAAI,CAAC,UAAU,EAAE;QAAE,OAAO,MAAM,EAAE,EAAE,CAAA;IAEpC,iEAAiE;IACjE,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IAC1E,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;QACzB,OAAO,CAAC,OAAO,EAAE,CAAA;QACjB,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,EAAE,CAAA;QACf,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,GAAY,EAAE,CAC/B,SAAS,EAAE,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAA"}

package/lib/version.d.ts

@@ -1,4 +1,4 @@
-declare const seamapiCliVersion = "0.10.0";
+declare const seamapiCliVersion = "0.11.0";
 declare const seamapiBlueprintVersion = "1.2.0";
 export { seamapiBlueprintVersion };
 export default seamapiCliVersion;

package/lib/version.js

@@ -1,5 +1,5 @@
 // Versions are replaced with generated values when the package is packed.
-const seamapiCliVersion = '0.10.0';
+const seamapiCliVersion = '0.11.0';
 const seamapiBlueprintVersion = '1.2.0';
 export { seamapiBlueprintVersion };
 export default seamapiCliVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/cli",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "A command line interface (CLI) for interacting with the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/bin/cli.ts

@@ -5,10 +5,10 @@ import { isDeepStrictEqual as isEqual } from 'node:util'
 import chalk from 'chalk'
 import commandLineUsage from 'command-line-usage'
 import type { ParsedArgs } from 'minimist'
-import prompts from 'prompts'
 
 import { getConfigStore } from 'lib/config/index.js'
 import { getApiBlueprint } from 'lib/get-api-blueprint.js'
+import { getResponseKey } from 'lib/get-response-key.js'
 import { getServer } from 'lib/get-server.js'
 import { interactForActionAttemptPoll } from 'lib/interact-for-action-attempt-poll.js'
 import { interactForCommandParams } from 'lib/interact-for-command-params.js'
@@ -17,14 +17,19 @@ import { interactForLogin } from 'lib/interact-for-login.js'
 import { interactForServerSelection } from 'lib/interact-for-server-selection.js'
 import { interactForUseRemoteApiDefs } from 'lib/interact-for-use-remote-api-defs.js'
 import { interactForWorkspaceId } from 'lib/interact-for-workspace-id.js'
+import { createOutput } from 'lib/output/create-output.js'
+import { getOutput, setOutput } from 'lib/output/get-output.js'
+import { resolveOutputFormat } from 'lib/output/resolve-output-format.js'
 import type { ContextHelpers } from 'lib/types.js'
 import {
+  cliFlags,
   getInteractivity,
   type Interactivity,
-  interactivityFlags,
   NonInteractiveError,
   parseCliArgs,
 } from 'lib/util/cli-args.js'
+import { canPrompt, prompt } from 'lib/util/prompt.js'
+import { readStdinJson } from 'lib/util/read-stdin-json.js'
 import { RequestSeamApi } from 'lib/util/request-seam-api.js'
 import { validateToken } from 'lib/validate-token.js'
 import seamapiCliVersion from 'lib/version.js'
@@ -58,6 +63,12 @@ const sections = [
         alias: 'y',
         type: Boolean,
       },
+      {
+        name: 'json',
+        description:
+          'Write the response to stdout as JSON. Enabled automatically when stdout is not a terminal, disable with {bold --no-json}.',
+        type: Boolean,
+      },
       {
         name: 'update',
         description: 'Force an update of the cached Seam API definitions.',
@@ -65,6 +76,14 @@ const sections = [
       },
     ],
   },
+  {
+    header: 'Output',
+    content: [
+      'Only the response is written to stdout, so it is safe to pipe. Prompts, progress, and other information are written to stderr.',
+      'The response is trimmed to the response key and pagination.',
+      'Request params may be piped or redirected in as a JSON object. Params given as arguments win over params read from stdin.',
+    ],
+  },
   {
     header: 'Command List Examples',
     content: [
@@ -100,22 +119,30 @@ const sections = [
         name: 'seam access-codes list {bold --device-id} $MY_DOOR',
         summary: 'List you access codes.',
       },
+      {
+        name: 'seam devices list > devices.json',
+        summary: 'Write the response to a file as JSON.',
+      },
+      {
+        name: 'cat params.json | seam locks unlock-door',
+        summary: 'Pipe request params in as JSON.',
+      },
     ],
   },
 ]
 
 async function cli(args: ParsedArgs) {
   const config = getConfigStore()
+  const output = getOutput()
 
   if (args['help'] || args['h']) {
-    const usage = commandLineUsage(sections)
-    console.log(usage)
+    output.text(commandLineUsage(sections))
     return
   }
 
   if (args['version']) {
-    console.log(seamapiCliVersion)
-    process.exit(0)
+    output.text(seamapiCliVersion)
+    return
   }
 
   if (
@@ -127,10 +154,10 @@ async function cli(args: ParsedArgs) {
     const fakeApiUrl = `https://${randomstring}.fakeseamconnect.seam.vc`
 
     config.set('server', fakeApiUrl)
-    console.log(`Server URL set to ${fakeApiUrl}`)
+    output.info(`Server URL set to ${fakeApiUrl}`)
 
     config.set(`${getServer()}.pat`, `seam_apikey1_token`)
-    console.log(`PAT set to use fakeseamconnect with "seam_apikey1_token"`)
+    output.info(`PAT set to use fakeseamconnect with "seam_apikey1_token"`)
     return
   }
 
@@ -139,8 +166,9 @@ async function cli(args: ParsedArgs) {
     args._[0] !== 'login' &&
     !isEqual(args._, ['select', 'server'])
   ) {
-    console.log(`Not logged in. Please run "seam login"`)
-    process.exit(1)
+    output.error(`Not logged in. Please run "seam login"`)
+    process.exitCode = 1
+    return
   }
 
   args._ = args._.map((arg) => arg.toLowerCase().replace(/_/g, '-'))
@@ -158,11 +186,13 @@ async function cli(args: ParsedArgs) {
     update,
   })
 
-  const commandParams: Record<string, any> = {}
+  // Params piped or redirected in, e.g., `seam devices list < params.json`.
+  // Params given as arguments take precedence over these.
+  const commandParams: Record<string, any> = { ...(await readStdinJson()) }
 
   const ctx: ContextHelpers = {
     blueprint,
-    interactivity: getInteractivity(args),
+    interactivity: getInteractivity(args, { canPrompt: canPrompt() }),
   }
 
   const isNonInteractive = ctx.interactivity === 'non-interactive'
@@ -173,7 +203,7 @@ async function cli(args: ParsedArgs) {
     delete args[k]
     const key = k.replace(/-/g, '_')
     args[key] = v
-    if (interactivityFlags.includes(key)) continue
+    if (cliFlags.includes(key)) continue
     commandParams[key] = v
   }
 
@@ -204,10 +234,10 @@ async function cli(args: ParsedArgs) {
     return
   } else if (isEqual(selectedCommand, ['logout'])) {
     config.delete('pat')
-    console.log('Logged out!')
+    output.info('Logged out!')
     return
   } else if (isEqual(selectedCommand, ['config', 'reveal-location'])) {
-    console.log(config.path)
+    output.text(config.path)
     return
   } else if (isEqual(selectedCommand, ['config', 'use-remote-api-defs'])) {
     if (isNonInteractive) {
@@ -291,6 +321,7 @@ async function cli(args: ParsedArgs) {
   const response = await RequestSeamApi({
     path: apiPath,
     params,
+    responseKey: getResponseKey(selectedCommand, ctx),
   })
 
   if (response.data?.connect_webview) {
@@ -301,7 +332,7 @@ async function cli(args: ParsedArgs) {
   }
 
   if (response.data?.action_attempt && !isNonInteractive) {
-    interactForActionAttemptPoll(response.data.action_attempt)
+    await interactForActionAttemptPoll(response.data.action_attempt)
   }
 }
 
@@ -315,7 +346,7 @@ const handleConnectWebviewResponse = async (
     interactivity !== 'non-interactive' &&
     process.env['INSIDE_WEB_BROWSER'] !== '1'
   ) {
-    const { action } = await prompts({
+    const { action } = await prompt({
       type: 'confirm',
       name: 'action',
       message: 'Would you like to open the webview in your browser?',
@@ -338,17 +369,30 @@ const run = async (argv: string[]) => {
     return
   }
 
-  await cli(parseCliArgs(argv))
+  const args = parseCliArgs(argv)
+
+  const isTty = process.stdout.isTTY === true
+
+  setOutput(
+    createOutput({
+      format: resolveOutputFormat(argv, { isTty }),
+      colors: isTty,
+    }),
+  )
+
+  await cli(args)
 }
 
-run(process.argv.slice(2)).catch((e) => {
+run(process.argv.slice(2)).catch((e: unknown) => {
+  const output = getOutput()
+  process.exitCode = 1
+
   if (e instanceof NonInteractiveError) {
-    console.log(chalk.red(e.message))
-    process.exit(1)
+    output.error(chalk.red(e.message))
+    return
   }
 
-  console.log(chalk.red(`CLI Error: ${e.toString()}\n${e.stack}`))
-  if (e.toString().includes('object Object')) {
-    console.log(e)
-  }
+  const error = e instanceof Error ? e : new Error(String(e))
+  output.error(chalk.red(`CLI Error: ${error.message}`))
+  if (error.stack != null) output.error(chalk.gray(error.stack))
 })

package/src/lib/get-response-key.ts

@@ -0,0 +1,25 @@
+import { getCommandBlueprintDef } from './get-command-blueprint-def.js'
+import type { ContextHelpers } from './types.js'
+
+/**
+ * The top level response key documented for a command,
+ * e.g., `devices` for `seam devices list`.
+ *
+ * Returns null when the command is not in the blueprint,
+ * or when it does not respond with a resource.
+ */
+export const getResponseKey = (
+  command: string[],
+  ctx: ContextHelpers,
+): string | null => {
+  let endpoint
+  try {
+    endpoint = getCommandBlueprintDef(command, ctx)
+  } catch {
+    return null
+  }
+
+  if (endpoint.response.responseType === 'void') return null
+
+  return endpoint.response.responseKey
+}

package/src/lib/interact-for-action-attempt-poll.ts

@@ -1,14 +1,15 @@
 import type { ActionAttemptsGetResponse } from '@seamapi/http/connect'
-import prompts from 'prompts'
 
 import { getSeam } from './get-seam.js'
+import { getOutput } from './output/get-output.js'
+import { prompt } from './util/prompt.js'
 import { withLoading } from './util/with-loading.js'
 
 export const interactForActionAttemptPoll = async (
   action_attempt: ActionAttemptsGetResponse['action_attempt'],
 ) => {
   if (action_attempt.status === 'pending') {
-    const { poll_for_action_attempt } = await prompts({
+    const { poll_for_action_attempt } = await prompt({
       name: 'poll_for_action_attempt',
       message: "Would you like to poll the action attempt until it's ready?",
       type: 'toggle',
@@ -29,7 +30,7 @@ export const interactForActionAttemptPoll = async (
             { waitForActionAttempt: { pollingInterval: 240, timeout: 10_000 } },
           ),
       )
-      console.dir(updated_action_attempt, { depth: null })
+      getOutput().data({ action_attempt: updated_action_attempt })
     }
   }
 }

package/src/lib/interact-for-array.ts

@@ -1,19 +1,21 @@
-import prompts from 'prompts'
+import { getOutput } from './output/get-output.js'
+import { prompt } from './util/prompt.js'
 
 export const interactForArray = async (
   array: string[],
   message: string,
 ): Promise<string[]> => {
   const updatedArray = [...array]
+  const output = getOutput()
 
   const displayList = () => {
-    console.log(`${message} Current list:`)
+    output.info(`${message} Current list:`)
     if (updatedArray.length > 0) {
       updatedArray.forEach((item, index) => {
-        console.log(`${index + 1}: ${item}`)
+        output.info(`${index + 1}: ${item}`)
       })
     } else {
-      console.log('The list is currently empty.')
+      output.info('The list is currently empty.')
     }
   }
 
@@ -21,7 +23,7 @@ export const interactForArray = async (
   do {
     displayList()
 
-    const response = await prompts({
+    const response = await prompt({
       type: 'select',
       name: 'action',
       message: 'Choose an action:',
@@ -35,7 +37,7 @@ export const interactForArray = async (
     action = response.action
 
     if (action === 'add') {
-      const { newItem } = await prompts({
+      const { newItem } = await prompt({
         type: 'text',
         name: 'newItem',
         message: 'Enter the new item:',
@@ -44,7 +46,7 @@ export const interactForArray = async (
         updatedArray.push(newItem)
       }
     } else if (action === 'remove') {
-      const { index } = await prompts({
+      const { index } = await prompt({
         type: 'number',
         name: 'index',
         message: 'Enter the index of the item to remove:',

package/src/lib/interact-for-blueprint-object.ts

@@ -1,5 +1,4 @@
 import type { Parameter } from '@seamapi/blueprint'
-import prompts from 'prompts'
 
 import { interactForAccessCode } from './interact-for-access-code.js'
 import { interactForAcsEntrance } from './interact-for-acs-entrance.js'
@@ -11,9 +10,11 @@ import { interactForCustomMetadata } from './interact-for-custom-metadata.js'
 import { interactForDevice } from './interact-for-device.js'
 import { interactForTimestamp } from './interact-for-timestamp.js'
 import { interactForUserIdentity } from './interact-for-user-identity.js'
+import { getOutput } from './output/get-output.js'
 import type { ContextHelpers } from './types.js'
 import { NonInteractiveError, toArgName } from './util/cli-args.js'
 import { ellipsis } from './util/ellipsis.js'
+import { prompt } from './util/prompt.js'
 
 const ergonomicPropOrder = [
   'name',
@@ -82,8 +83,8 @@ export const interactForBlueprintObject = async (
     ? `Editing "${args.subPropertyPath}"`
     : `[${cmdPath}] Parameters`
 
-  console.log('')
-  const { paramToEdit } = await prompts({
+  getOutput().info()
+  const { paramToEdit } = await prompt({
     name: 'paramToEdit',
     message: parameterSelectionMessage,
     type: 'autocomplete',
@@ -203,7 +204,7 @@ export const interactForBlueprintObject = async (
         value = await interactForTimestamp()
       } else {
         value = (
-          await prompts({
+          await prompt({
             name: 'value',
             message: `${paramToEdit}:`,
             type: 'text',
@@ -214,7 +215,7 @@ export const interactForBlueprintObject = async (
       return interactForBlueprintObject(args, ctx)
     } else if (prop.format === 'enum') {
       const value = (
-        await prompts({
+        await prompt({
           name: 'value',
           message: `${paramToEdit}:`,
           type: 'select',
@@ -227,7 +228,7 @@ export const interactForBlueprintObject = async (
       args.params[paramToEdit] = value
       return interactForBlueprintObject(args, ctx)
     } else if (prop.format === 'boolean') {
-      const { value } = await prompts({
+      const { value } = await prompt({
         name: 'value',
         message: `${paramToEdit}:`,
         type: 'toggle',
@@ -241,7 +242,7 @@ export const interactForBlueprintObject = async (
       return interactForBlueprintObject(args, ctx)
     } else if (prop.format === 'list' && prop.itemFormat === 'enum') {
       const value = (
-        await prompts({
+        await prompt({
           name: 'value',
           message: `${paramToEdit}:`,
           type: 'autocompleteMultiselect',
@@ -272,7 +273,7 @@ export const interactForBlueprintObject = async (
       )
       return interactForBlueprintObject(args, ctx)
     } else if (prop.format === 'number') {
-      const { value } = await prompts({
+      const { value } = await prompt({
         name: 'value',
         message: `${paramToEdit}:`,
         type: 'number',

package/src/lib/interact-for-command-selection.ts

@@ -1,9 +1,8 @@
 import { isDeepStrictEqual as isEqual } from 'node:util'
 
-import prompts from 'prompts'
-
 import type { ContextHelpers } from './types.js'
 import { NonInteractiveError } from './util/cli-args.js'
+import { prompt } from './util/prompt.js'
 
 const uniqBy = <T>(items: T[], keyOf: (item: T) => unknown): T[] => {
   const seen = new Set<unknown>()
@@ -93,7 +92,7 @@ export async function interactForCommandSelection(
 
   const commandPathStr = commandPath.join('/').replace(/-/g, '_')
 
-  const res = await prompts({
+  const res = await prompt({
     name: 'Command',
     type: 'autocomplete',
     choices: [