bdy 1.25.3-dev → 1.25.5-dev

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.3-dev",
+  "version": "1.25.5-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",
@@ -16,6 +16,7 @@
     "e2e": "npm run buildTs && vitest run --config e2e/vitest.config.mts",
     "e2e:version": "vitest run --config e2e/vitest.config.mts e2e/modules/version/",
     "e2e:discover": "vitest run --config e2e/vitest.discover.config.mts",
+    "e2e:errors": "vitest run --config e2e/vitest.errors.config.mts",
     "e2e:tunnel-config": "vitest run --config e2e/vitest.config.mts e2e/modules/tunnel-config/",
     "e2e:auth": "vitest run --config e2e/vitest.config.mts e2e/modules/auth/",
     "e2e:workspace": "vitest run --config e2e/vitest.config.mts e2e/modules/workspace/",

package/distTs/src/agent/socket/tunnel.js

@@ -30,6 +30,7 @@ class AgentSocketTunnel extends events_1.default {
     totalConnections;
     connections;
     dns;
+    rawStatus;
     constructor(socket, id) {
         super();
         this.id = id;
@@ -65,6 +66,7 @@ class AgentSocketTunnel extends events_1.default {
         };
     }
     onTunnelData(data) {
+        this.rawStatus = data;
         if (data.regionLatency)
             this.regionLatency = data.regionLatency;
         if (data.targetLatency)

package/distTs/src/api/client.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formDataFileName = void 0;
 const texts_1 = require("../texts");
+const cliError_1 = __importDefault(require("../cliError"));
 const logger_1 = __importDefault(require("../logger"));
 const utils_1 = require("../utils");
 const node_fs_1 = __importDefault(require("node:fs"));
@@ -155,7 +156,9 @@ class ApiClient {
                     await (0, utils_1.sleep)(attempt * 1000);
                     continue;
                 }
-                throw new Error(retriable ? texts_1.ERR_REST_API_CONNECT_ERROR : texts_1.ERR_REST_API_GENERAL_ERROR, { cause: err });
+                const networkCode = err.code ?? err.cause?.code;
+                const timeout = ['ETIMEDOUT', 'UND_ERR_CONNECT_TIMEOUT', 'UND_ERR_HEADERS_TIMEOUT', 'UND_ERR_BODY_TIMEOUT'].includes(networkCode);
+                throw new cliError_1.default(timeout ? 'timeout' : 'connection_error', timeout ? texts_1.ERR_REST_API_TIMEOUT : texts_1.ERR_REST_API_CONNECT_ERROR, timeout ? texts_1.TXT_CLI_RETRY_HINT : texts_1.TXT_CLI_ENDPOINT_HINT, { cause: err });
             }
             rateLimitReset = headerValue(response.headers['x-rate-limit-reset']);
             status = response.statusCode;
@@ -173,7 +176,8 @@ class ApiClient {
         this.warnRateLimitLow(headerValue(response.headers['x-rate-limit-remaining']), rateLimitReset);
         if (status === 429) {
             await responseBody.dump();
-            throw new Error((0, texts_1.ERR_REST_API_RATE_LIMIT)(rateLimitReset));
+            const error = (0, texts_1.ERR_API_DETAILS)(status, undefined, path, this.baseUrl, rateLimitReset);
+            throw new cliError_1.default(error.code, error.message, error.hint);
         }
         if (status === 401) {
             await responseBody.dump();
@@ -194,43 +198,7 @@ class ApiClient {
                     });
                 }
             }
-            throw new Error(texts_1.ERR_REST_API_WRONG_TOKEN);
-        }
-        if (status === 403) {
-            let json;
-            try {
-                json = await responseBody.json();
-                logger_1.default.debug('API CLIENT PARSED RESPONSE:');
-                logger_1.default.debug(json);
-            }
-            catch {
-                await responseBody.dump();
-                throw new Error((0, texts_1.ERR_REST_API_RATE_LIMIT)(rateLimitReset));
-            }
-            if (json.errors && json.errors[0] && json.errors[0].message) {
-                throw new Error((0, texts_1.ERR_API_MESSAGE_REPLACER)(json.errors[0].message, path, this.baseUrl, rateLimitReset));
-            }
-            throw new Error((0, texts_1.ERR_REST_API_RATE_LIMIT)(rateLimitReset));
-        }
-        if ([400, 404].includes(status)) {
-            let json;
-            try {
-                json = await responseBody.json();
-            }
-            catch (err) {
-                logger_1.default.debug('API CLIENT PARSED RESPONSE ERROR:');
-                logger_1.default.debug(err);
-                throw new Error(texts_1.ERR_REST_API_GENERAL_ERROR, { cause: err });
-            }
-            logger_1.default.debug('API CLIENT PARSED RESPONSE:');
-            logger_1.default.debug(json);
-            if (json.errors && json.errors[0] && json.errors[0].message) {
-                throw new Error((0, texts_1.ERR_API_MESSAGE_REPLACER)(json.errors[0].message, path, this.baseUrl, rateLimitReset));
-            }
-            if (status === 404)
-                throw new Error(texts_1.ERR_REST_API_RESOURCE_NOT_FOUND);
-            else
-                throw new Error((0, texts_1.ERR_REST_API_HTTP_ERROR)(status));
+            throw new cliError_1.default('unauthorized', texts_1.ERR_REST_API_UNAUTHORIZED, texts_1.TXT_CLI_LOGIN_HINT);
         }
         if ([200, 201].includes(status)) {
             if (parseResponseBody) {
@@ -267,26 +235,25 @@ class ApiClient {
             await responseBody.dump();
             return null;
         }
-        else if (status === 503) {
-            throw new Error(texts_1.ERR_REST_API_NOT_RESPONDING);
-        }
         else {
-            // Any other error status (409, 422, 5xx...): surface the API's own
-            // message when the body carries one (e.g. "Concurrency limit reached")
-            // instead of reducing it to a bare HTTP code.
-            let json;
+            let message;
+            let nonJsonBody = false;
             try {
-                json = await responseBody.json();
-            }
-            catch {
-                throw new Error((0, texts_1.ERR_REST_API_HTTP_ERROR)(status));
+                const json = await responseBody.json();
+                logger_1.default.debug('API CLIENT PARSED RESPONSE:');
+                logger_1.default.debug(json);
+                const value = json?.errors?.[0]?.message;
+                if (typeof value === 'string')
+                    message = value;
             }
-            logger_1.default.debug('API CLIENT PARSED RESPONSE:');
-            logger_1.default.debug(json);
-            if (json.errors && json.errors[0] && json.errors[0].message) {
-                throw new Error((0, texts_1.ERR_API_MESSAGE_REPLACER)(json.errors[0].message, path, this.baseUrl, rateLimitReset));
+            catch (err) {
+                nonJsonBody = true;
+                logger_1.default.debug(err);
             }
-            throw new Error((0, texts_1.ERR_REST_API_HTTP_ERROR)(status));
+            // Edge/WAF throttling uses 403 with an HTML body. Preserve the legacy
+            // rate-limit classification; JSON 403 responses still report API errors.
+            const error = (0, texts_1.ERR_API_DETAILS)(status === 403 && nonJsonBody ? 429 : status, message, path, this.baseUrl, rateLimitReset);
+            throw new cliError_1.default(error.code, error.message, error.hint);
         }
     }
     // Set by the CLI bootstrap (Input.restApiTokenClient); the transport layer

package/distTs/src/cliCommand.js

@@ -1,6 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
+const output_1 = __importDefault(require("./output"));
+const cliError_1 = __importDefault(require("./cliError"));
+const texts_1 = require("./texts");
 /** Command documentation shared by terminal help and machine discovery. */
 class CliCommand extends commander_1.Command {
     agentStatus;
@@ -13,11 +19,57 @@ class CliCommand extends commander_1.Command {
     hideVersionUpdate;
     agentPort;
     skipPre = false;
+    defaultErrorFormat = 'text';
     metadata;
     constructor(name, metadata = {}) {
         super(name);
         this.metadata = metadata;
     }
+    addOption(option) {
+        if (option.long === '--format' && !option.argChoices) {
+            const choices = option.flags.match(/<([^>]+)>/)?.[1].split('|');
+            if (choices?.every((value) => ['text', 'json', 'jsonl'].includes(value)))
+                option.choices(choices);
+        }
+        return super.addOption(option);
+    }
+    parseOptions(args) {
+        output_1.default.errorFormat = this.defaultErrorFormat;
+        const formatOption = this.options.find((option) => option.long === '--format');
+        if (formatOption && this.defaultErrorFormat === 'text') {
+            // Let Commander handle option syntax without running our parsers, hooks
+            // or actions. Even if a required value is missing, earlier format values
+            // are available before the real parser reports the error.
+            const probe = new commander_1.Command()
+                .exitOverride()
+                .configureOutput({ writeErr: () => { } });
+            for (const option of this.options)
+                probe.option(option.flags);
+            try {
+                probe.parseOptions(args);
+            }
+            catch (err) {
+                if (!(err instanceof commander_1.CommanderError))
+                    throw err;
+            }
+            const format = probe.opts().format;
+            if (formatOption.argChoices?.includes(format) &&
+                (format === 'json' || format === 'jsonl'))
+                output_1.default.errorFormat = format;
+        }
+        this.showSuggestionAfterError(output_1.default.errorFormat === 'text');
+        return super.parseOptions(args);
+    }
+    error(message, options) {
+        if (output_1.default.errorFormat === 'text')
+            return super.error(message, options);
+        const path = [this.name()];
+        for (let command = this.parent; command; command = command.parent)
+            path.unshift(command.name());
+        output_1.default.exitError(new cliError_1.default(options?.code === 'commander.unknownCommand'
+            ? 'unknown_command'
+            : 'usage_error', message.replace(/^error: /, '').trim(), (0, texts_1.TXT_CLI_USAGE_HINT)(path.join(' '))));
+    }
     get requiredScopes() {
         return this.metadata.requiredScopes ?? null;
     }

package/distTs/src/cliError.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class CliError extends Error {
+    code;
+    hint;
+    constructor(code, message, hint = null, options) {
+        super(message, options);
+        this.code = code;
+        this.hint = hint;
+        this.name = 'CliError';
+    }
+    static details(error) {
+        if (error instanceof CliError) {
+            return { code: error.code, message: error.message, hint: error.hint };
+        }
+        const { code, syscall } = error ?? {};
+        const missingFile = code === 'ENOENT' &&
+            [
+                'open',
+                'stat',
+                'lstat',
+                'access',
+                'scandir',
+                'readlink',
+                'realpath',
+            ].includes(syscall ?? '');
+        return {
+            code: missingFile ? 'file_not_found' : 'command_failed',
+            message: error instanceof Error ? error.message : String(error),
+            hint: null,
+        };
+    }
+}
+exports.default = CliError;

package/distTs/src/cliIndex.js

@@ -30,6 +30,8 @@ const environment_1 = __importDefault(require("./command/environment"));
 const register_1 = __importDefault(require("./command/register"));
 const mcp_1 = __importDefault(require("./command/mcp"));
 const discover_1 = __importDefault(require("./command/discover"));
+const cliError_1 = __importDefault(require("./cliError"));
+const texts_2 = require("./texts");
 function cliIndex() {
     const program = (0, utils_1.newCommand)('bdy', texts_1.DESC_PROGRAM);
     program.hook('preAction', pre_1.default);
@@ -65,7 +67,7 @@ function cliIndex() {
     program.addCommand(discover_1.default);
     program.action((_, cmd) => {
         if (cmd.args.length > 0) {
-            output_1.default.exitError((0, texts_1.ERR_COMMAND_NOT_FOUND)(cmd.args[0]));
+            output_1.default.exitError(new cliError_1.default('unknown_command', (0, texts_1.ERR_COMMAND_NOT_FOUND)(cmd.args[0]), (0, texts_2.TXT_CLI_USAGE_HINT)('bdy')));
         }
         program.help();
     });

package/distTs/src/command/agent/proxy/status.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentProxyStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_PROXY_STATUS);
-commandAgentProxyStatus.action(async () => {
+const commandAgentProxyStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_PROXY_STATUS, { examples: texts_1.EXAMPLE_AGENT_PROXY_STATUS });
+commandAgentProxyStatus.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentProxyStatus.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentProxyStatus.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,6 +19,12 @@ commandAgentProxyStatus.action(async () => {
     try {
         const api = new ApiAgent(commandAgentProxyStatus.agentPort || 0);
         const data = await api.fetchAgentProxy();
+        if (options.format === 'json') {
+            output_1.default.json(data);
+            if (!data.proxy)
+                output_1.default.exitError(texts_1.TXT_AGENT_PROXY_DISABLED);
+            output_1.default.exitNormal();
+        }
         if (data.proxy) {
             output_1.default.exitSuccess(texts_1.TXT_AGENT_PROXY_ENABLED);
         }

package/distTs/src/command/agent/status.js

@@ -8,8 +8,8 @@ const node_fs_1 = require("node:fs");
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const tunnel_1 = require("../../types/tunnel");
-const commandAgentStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_STATUS);
-const outputStatus = (installed, standalone, version, id, running, enabled, target, tunneling, proxy, status) => {
+const commandAgentStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_STATUS, { examples: texts_1.EXAMPLE_AGENT_STATUS, helpText: texts_1.HELP_AGENT_STATUS_JSON });
+const outputStatus = (installed, standalone, version, id, running, enabled, target, tunneling, proxy, status, json) => {
     const AgentManager = require('../../agent/manager').default;
     if (!installed) {
         // Nothing loaded, yet there is a file where the install would be - it is unreadable or not
@@ -22,6 +22,22 @@ const outputStatus = (installed, standalone, version, id, running, enabled, targ
         }
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
     }
+    const orphan = AgentManager.system.getStandaloneConfigPath();
+    const orphanedConfig = !AgentManager.system.isUserOwnedInstall() && (0, node_fs_1.existsSync)(orphan)
+        ? orphan
+        : null;
+    if (json) {
+        output_1.default.json({
+            ...commandAgentStatus.agentStatus,
+            installed,
+            standalone,
+            id: id ?? null,
+            version: version || null,
+            running,
+            orphaned_config: orphanedConfig,
+        });
+        output_1.default.exitNormal();
+    }
     let txt = 'Installation: ';
     if (standalone)
         txt += 'App @ ';
@@ -66,13 +82,13 @@ const outputStatus = (installed, standalone, version, id, running, enabled, targ
     // above: an install made before those files moved keeps its config in the system directory
     // and reports itself as an app, and a leftover in the home is just as inert next to it.
     // Inert, but only findable if it is said out loud.
-    const orphan = AgentManager.system.getStandaloneConfigPath();
-    if (!AgentManager.system.isUserOwnedInstall() && (0, node_fs_1.existsSync)(orphan)) {
+    if (orphanedConfig) {
         output_1.default.error((0, texts_1.TXT_AGENT_APP_INSTALL_ORPHANED)(orphan));
     }
     output_1.default.exitNormal();
 };
-commandAgentStatus.action(async () => {
+commandAgentStatus.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentStatus.action((options) => {
     let version = '';
     const id = commandAgentStatus.agentId;
     const running = !!commandAgentStatus.agentStatus;
@@ -89,6 +105,6 @@ commandAgentStatus.action(async () => {
         tunneling = commandAgentStatus.agentStatus.tunneling;
         proxy = commandAgentStatus.agentStatus.proxy;
     }
-    outputStatus(!!commandAgentStatus.agentInstalled, !!commandAgentStatus.agentStandalone, version, id, running, enabled, target, tunneling, proxy, status);
+    outputStatus(!!commandAgentStatus.agentInstalled, !!commandAgentStatus.agentStandalone, version, id, running, enabled, target, tunneling, proxy, status, options.format === 'json');
 });
 exports.default = commandAgentStatus;

package/distTs/src/command/agent/tags/get.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentTagsGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_AGENT_TAGS_GET);
-commandAgentTagsGet.action(async () => {
+const commandAgentTagsGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_AGENT_TAGS_GET, { examples: texts_1.EXAMPLE_AGENT_TAGS_GET });
+commandAgentTagsGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTagsGet.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentTagsGet.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,6 +19,12 @@ commandAgentTagsGet.action(async () => {
     try {
         const api = new ApiAgent(commandAgentTagsGet.agentPort || 0);
         const data = await api.fetchAgentTags();
+        if (options.format === 'json') {
+            output_1.default.json(data);
+            if (!data.tags?.length)
+                output_1.default.exitError(texts_1.TXT_AGENT_NO_TAGS);
+            output_1.default.exitNormal();
+        }
         if (data.tags && data.tags.length > 0) {
             output_1.default.exitNormal(data.tags.join(' '));
         }

package/distTs/src/command/agent/target/status.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentTargetStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_TARGET_STATUS);
-commandAgentTargetStatus.action(async () => {
+const commandAgentTargetStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_TARGET_STATUS, { examples: texts_1.EXAMPLE_AGENT_TARGET_STATUS });
+commandAgentTargetStatus.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTargetStatus.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentTargetStatus.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,6 +19,12 @@ commandAgentTargetStatus.action(async () => {
     try {
         const api = new ApiAgent(commandAgentTargetStatus.agentPort || 0);
         const data = await api.fetchAgentTarget();
+        if (options.format === 'json') {
+            output_1.default.json(data);
+            if (!data.target)
+                output_1.default.exitError(texts_1.TXT_AGENT_TARGET_DISABLED);
+            output_1.default.exitNormal();
+        }
         if (data.target) {
             output_1.default.exitSuccess(texts_1.TXT_AGENT_TARGET_ENABLED);
         }

package/distTs/src/command/agent/tunnel/list.js

@@ -8,7 +8,8 @@ const texts_1 = require("../../../texts");
 const utils_1 = require("../../../utils");
 const commandAgentTunnelList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_AGENT_TUNNEL_LIST, { examples: texts_1.EXAMPLE_AGENT_TUNNEL_LIST });
 commandAgentTunnelList.alias('ls');
-commandAgentTunnelList.action(async () => {
+commandAgentTunnelList.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTunnelList.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentTunnelList.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -19,6 +20,10 @@ commandAgentTunnelList.action(async () => {
     try {
         const api = new ApiAgent(commandAgentTunnelList.agentPort || 0);
         const data = await api.fetchTunnels();
+        if (options.format === 'json') {
+            output_1.default.json(data);
+            output_1.default.exitNormal();
+        }
         output_1.default.agentTunnels(data.tunnels);
     }
     catch (err) {

package/distTs/src/command/agent/tunnel/status.js

@@ -8,7 +8,8 @@ const output_1 = __importDefault(require("../../../output"));
 const utils_1 = require("../../../utils");
 const commandAgentTunnelStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_TUNNEL_STATUS, { examples: texts_1.EXAMPLE_AGENT_TUNNEL_STATUS });
 commandAgentTunnelStatus.argument('[id]', texts_1.OPTION_ID);
-commandAgentTunnelStatus.action(async (id) => {
+commandAgentTunnelStatus.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTunnelStatus.action(async (id, options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     const AgentSocketTunnel = require('../../../agent/socket/tunnel').default;
     if (!commandAgentTunnelStatus.agentInstalled) {
@@ -21,6 +22,12 @@ commandAgentTunnelStatus.action(async (id) => {
         const api = new ApiAgent(commandAgentTunnelStatus.agentPort || 0);
         if (!id) {
             const data = await api.fetchAgentTunneling();
+            if (options.format === 'json') {
+                output_1.default.json(data);
+                if (!data.tunneling)
+                    output_1.default.exitError(texts_1.TXT_AGENT_TUNNELING_DISABLED);
+                output_1.default.exitNormal();
+            }
             if (data.tunneling) {
                 output_1.default.exitSuccess(texts_1.TXT_AGENT_TUNNELING_ENABLED);
             }
@@ -32,6 +39,11 @@ commandAgentTunnelStatus.action(async (id) => {
         const ws = await api.socketTunnel(id);
         const tunnel = new AgentSocketTunnel(ws, id);
         await tunnel.waitForReady();
+        if (options.format === 'json') {
+            output_1.default.json(tunnel.rawStatus);
+            tunnel.close();
+            output_1.default.exitNormal();
+        }
         output_1.default.tunnel(tunnel);
     }
     catch (err) {

package/distTs/src/command/agent/version.js

@@ -6,14 +6,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
-const commandAgentVersion = (0, utils_1.newCommand)('version', texts_1.DESC_COMMAND_AGENT_VERSION);
-commandAgentVersion.action(async () => {
+const commandAgentVersion = (0, utils_1.newCommand)('version', texts_1.DESC_COMMAND_AGENT_VERSION, { examples: texts_1.EXAMPLE_AGENT_VERSION });
+commandAgentVersion.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentVersion.action(async (options) => {
     if (!commandAgentVersion.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
     }
     if (!commandAgentVersion.agentStatus) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_RUNNING);
     }
+    if (options.format === 'json') {
+        output_1.default.json(commandAgentVersion.agentStatus);
+        output_1.default.exitNormal();
+    }
     output_1.default.exitNormal(commandAgentVersion.agentStatus.version);
 });
 exports.default = commandAgentVersion;

package/distTs/src/command/api/info.js

@@ -9,6 +9,8 @@ const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 /** `members` keeps declaration order, which numbers the listing; `values` does not. */
 const orderedMembers = (body) => {
+    if (body.kind === 'array')
+        return orderedMembers(body.items);
     if (body.kind !== 'union')
         return [];
     const members = body.discriminator?.members;
@@ -217,15 +219,19 @@ const chosen = (asked, names) => {
     const position = Number(asked);
     return Number.isInteger(position) && position >= 1 ? names[position - 1] : undefined;
 };
-const commandApiInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_API_INFO);
+const commandApiInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_API_INFO, {
+    helpText: texts_1.HELP_API_INFO_JSON,
+    examples: texts_1.EXAMPLE_API_INFO,
+});
 commandApiInfo.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandApiInfo.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandApiInfo.option('--request-schema <schema>', texts_1.OPT_COMMAND_API_INFO_SCHEMA);
 commandApiInfo.option('--response-schema <schema>', texts_1.OPT_COMMAND_API_INFO_SCHEMA);
 commandApiInfo.argument('<method>', texts_1.OPT_COMMAND_API_INFO_METHOD);
 commandApiInfo.argument('<url>', texts_1.OPT_COMMAND_API_INFO_URL);
+commandApiInfo.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandApiInfo.action(async (fm, filterUrl, options) => {
-    const { apiEndpoints } = require('../../openapi');
+    const { apiEndpoints, apiSpecification } = require('../../openapi');
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project, true);
     const method = (input_1.default.restApiMethod(fm, false) ?? '').toLowerCase();
@@ -246,6 +252,48 @@ commandApiInfo.action(async (fm, filterUrl, options) => {
     const namesOf = (bodies) => bodies.flatMap((body) => [...orderedMembers(body)]);
     const request = chosen(options.requestSchema, namesOf((listed.request?.contents ?? []).map((content) => content.body)));
     const response = chosen(options.responseSchema, namesOf(listed.responses.flatMap((one) => one.contents.map((content) => content.body))));
+    if (options.format === 'json') {
+        const raw = await apiSpecification(client.baseUrl);
+        const schema = (asked, selected, bodies) => {
+            const refs = [];
+            for (let body of bodies) {
+                while (body.kind === 'array')
+                    body = body.items;
+                if (body.kind === 'union' && selected) {
+                    const name = memberDef(body, selected);
+                    if (name && raw.components?.schemas?.[name])
+                        return raw.components.schemas[name];
+                }
+                if ('ref' in body && body.ref)
+                    refs.push(body.ref.name);
+            }
+            // Union positions use the same member list as text output. Only bodies
+            // without unions use reference positions across response/content order.
+            const name = refs.includes(asked)
+                ? asked
+                : namesOf(bodies).length === 0
+                    ? chosen(asked, refs)
+                    : undefined;
+            if (name && raw.components?.schemas?.[name])
+                return raw.components.schemas[name];
+            output_1.default.exitError((0, texts_1.ERR_API_SCHEMA_NOT_FOUND)(asked));
+        };
+        const requestSchema = options.requestSchema
+            ? schema(options.requestSchema, request, (listed.request?.contents ?? []).map((content) => content.body))
+            : undefined;
+        const responseSchema = options.responseSchema
+            ? schema(options.responseSchema, response, listed.responses.flatMap((one) => one.contents.map((content) => content.body)))
+            : undefined;
+        output_1.default.json(requestSchema && responseSchema
+            ? { request: requestSchema, response: responseSchema }
+            : (requestSchema ??
+                responseSchema ?? {
+                method: wanted.method.toUpperCase(),
+                path: (0, utils_1.openApiPrepareUrl)(wanted.path, workspace, project),
+                operation: raw.paths[wanted.path][method],
+            }));
+        output_1.default.exitNormal();
+    }
     const member = request || response
         ? { ...(request ? { request } : {}), ...(response ? { response } : {}) }
         : undefined;

package/distTs/src/command/api/list.js

@@ -25,12 +25,15 @@ const outputUrl = (operation, workspace, project) => {
     if (operation.summary)
         output_1.default.gray(operation.summary);
 };
-const commandApiList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_API_LIST);
+const commandApiList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_API_LIST, {
+    examples: texts_1.EXAMPLE_API_LIST,
+});
 commandApiList.alias('ls');
 commandApiList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandApiList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandApiList.option('-m, --method <method>', texts_1.OPT_COMMAND_API_LIST_METHOD);
 commandApiList.option('-s, --search <phrase>', texts_1.OPT_COMMAND_API_LIST_SEARCH);
+commandApiList.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandApiList.action(async (options) => {
     const { apiEndpoints } = require('../../openapi');
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -39,12 +42,25 @@ commandApiList.action(async (options) => {
     const filter = options.search;
     const client = input_1.default.restApiTokenClient(true);
     const api = await apiEndpoints(client.baseUrl);
+    const operations = [];
     for (const operation of await api.operations()) {
         if (filter && !operation.path.includes(filter))
             continue;
         if (filterMethod && filterMethod !== operation.method.toLowerCase())
             continue;
-        outputUrl(operation, workspace, project);
+        if (options.format === 'json') {
+            operations.push({
+                method: operation.method.toUpperCase(),
+                path: (0, utils_1.openApiPrepareUrl)(operation.path, workspace, project),
+                summary: operation.summary,
+            });
+        }
+        else {
+            outputUrl(operation, workspace, project);
+        }
+    }
+    if (options.format === 'json') {
+        output_1.default.json(operations);
     }
     output_1.default.exitNormal();
 });

package/distTs/src/command/artifact/create.js

@@ -23,6 +23,7 @@ commandArtifactCreate.option('-a, --auth <user:pass>', texts_1.OPTION_HTTP_AUTH)
 commandArtifactCreate.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
 commandArtifactCreate.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
 commandArtifactCreate.argument('[name]', texts_1.OPT_COMMAND_ARTIFACT_NAME);
+commandArtifactCreate.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandArtifactCreate.action(async (name, options) => {
     const humanId = require('human-id').default;
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -71,6 +72,10 @@ commandArtifactCreate.action(async (name, options) => {
         };
     }
     const result = await client.createArtifact(workspace, data);
+    if (options.format === 'json') {
+        output_1.default.json(result);
+        output_1.default.exitNormal();
+    }
     output_1.default.exitSuccess((0, texts_1.TXT_ARTIFACT_CREATED)(client.baseUrl, workspace, result));
 });
 exports.default = commandArtifactCreate;