bdy 1.25.2-stage → 1.25.4-dev

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.2-stage",
+  "version": "1.25.4-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",
@@ -13,24 +13,25 @@
     "lint:types": "tsc --skipLibCheck --noEmit --project tsconfig.json && tsc --skipLibCheck --project test/tsconfig.json && tsc --skipLibCheck --project e2e/tsconfig.json",
     "watch": "tsc --watch --project tsconfig.json & tsc --watch --project src/visualTest/utils/tsconfig.json",
     "buildTs": "(tsc --project tsconfig.json & tsc --project src/visualTest/utils/tsconfig.json & wait) && cp package.json distTs/package.json && cp detect-rules.json distTs/detect-rules.json && curl -fsSL https://raw.githubusercontent.com/buddy/cli/main/README.md -o README.md",
-    "e2e": "npm run buildTs && vitest run --config e2e/vitest.config.ts",
-    "e2e:version": "vitest run --config e2e/vitest.config.ts e2e/modules/version/",
-    "e2e:tunnel-config": "vitest run --config e2e/vitest.config.ts e2e/modules/tunnel-config/",
-    "e2e:auth": "vitest run --config e2e/vitest.config.ts e2e/modules/auth/",
-    "e2e:workspace": "vitest run --config e2e/vitest.config.ts e2e/modules/workspace/",
-    "e2e:project": "vitest run --config e2e/vitest.config.ts e2e/modules/project/",
-    "e2e:artifact": "vitest run --config e2e/vitest.config.ts e2e/modules/artifact/",
-    "e2e:sandbox": "vitest run --config e2e/vitest.config.ts e2e/modules/sandbox/",
-    "e2e:api": "vitest run --config e2e/vitest.config.ts e2e/modules/api/",
-    "e2e:mcp": "vitest run --config e2e/vitest.config.ts e2e/modules/mcp/",
-    "e2e:pipeline": "vitest run --config e2e/vitest.config.ts e2e/modules/pipeline/",
-    "e2e:tunnel": "vitest run --config e2e/vitest.config.ts e2e/modules/tunnel/",
-    "e2e:agent": "vitest run --config e2e/vitest.config.ts e2e/modules/agent/",
-    "e2e:distro": "vitest run --config e2e/vitest.config.ts e2e/modules/distro/",
-    "e2e:target": "vitest run --config e2e/vitest.config.ts e2e/modules/target/",
-    "e2e:environment": "vitest run --config e2e/vitest.config.ts e2e/modules/environment/",
-    "e2e:yaml": "vitest run --config e2e/vitest.config.ts e2e/modules/yaml/",
-    "unit": "vitest run --config vitest.config.ts"
+    "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: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/",
+    "e2e:project": "vitest run --config e2e/vitest.config.mts e2e/modules/project/",
+    "e2e:artifact": "vitest run --config e2e/vitest.config.mts e2e/modules/artifact/",
+    "e2e:sandbox": "vitest run --config e2e/vitest.config.mts e2e/modules/sandbox/",
+    "e2e:api": "vitest run --config e2e/vitest.config.mts e2e/modules/api/",
+    "e2e:mcp": "vitest run --config e2e/vitest.config.mts e2e/modules/mcp/",
+    "e2e:pipeline": "vitest run --config e2e/vitest.config.mts e2e/modules/pipeline/",
+    "e2e:tunnel": "vitest run --config e2e/vitest.config.mts e2e/modules/tunnel/",
+    "e2e:agent": "vitest run --config e2e/vitest.config.mts e2e/modules/agent/",
+    "e2e:distro": "vitest run --config e2e/vitest.config.mts e2e/modules/distro/",
+    "e2e:target": "vitest run --config e2e/vitest.config.mts e2e/modules/target/",
+    "e2e:environment": "vitest run --config e2e/vitest.config.mts e2e/modules/environment/",
+    "e2e:yaml": "vitest run --config e2e/vitest.config.mts e2e/modules/yaml/",
+    "unit": "vitest run --config vitest.config.mts"
   },
   "files": [
     "distTs"

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/cliCommand.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+/** Command documentation shared by terminal help and machine discovery. */
+class CliCommand extends commander_1.Command {
+    agentStatus;
+    agentInstalled;
+    agentId;
+    agentStandalone;
+    currentVersion;
+    latestVersion;
+    env;
+    hideVersionUpdate;
+    agentPort;
+    skipPre = false;
+    metadata;
+    constructor(name, metadata = {}) {
+        super(name);
+        this.metadata = metadata;
+    }
+    get requiredScopes() {
+        return this.metadata.requiredScopes ?? null;
+    }
+    get examples() {
+        return this.metadata.examples ?? [];
+    }
+}
+exports.default = CliCommand;

package/distTs/src/cliIndex.js

@@ -29,8 +29,9 @@ const target_1 = __importDefault(require("./command/target"));
 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"));
 function cliIndex() {
-    const program = (0, utils_1.newCommand)('', texts_1.DESC_PROGRAM);
+    const program = (0, utils_1.newCommand)('bdy', texts_1.DESC_PROGRAM);
     program.hook('preAction', pre_1.default);
     program.configureHelp({
         formatHelp: utils_1.formatHelp,
@@ -61,6 +62,7 @@ function cliIndex() {
     program.addCommand(yaml_1.default);
     program.addCommand(api_1.default);
     program.addCommand(mcp_1.default);
+    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]));

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/http.js

@@ -7,11 +7,12 @@ const utils_1 = require("../../../utils");
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const tunnel_1 = require("../../../types/tunnel");
-const commandAgentTunnelHttp = (0, utils_1.getBasicCommandHttp)();
-commandAgentTunnelHttp.description(texts_1.DESC_COMMAND_HTTP);
+const commandAgentTunnelHttp = (0, utils_1.getBasicCommandHttp)({
+    examples: (0, texts_1.EXAMPLE_TUNNEL_HTTP)(true),
+});
+commandAgentTunnelHttp.description(texts_1.DESC_COMMAND_AGENT_TUNNEL_HTTP);
 commandAgentTunnelHttp.option('-f, --follow', texts_1.OPTION_FOLLOW);
 commandAgentTunnelHttp.argument('[protocol://host:port]', texts_1.OPTION_TARGET);
-commandAgentTunnelHttp.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_HTTP)(true)}`);
 commandAgentTunnelHttp.action(async (target, options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     const AgentSocketTunnel = require('../../../agent/socket/tunnel').default;

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

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const utils_1 = require("../../../utils");
-const commandAgentTunnelList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_AGENT_TUNNEL_LIST);
+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.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_AGENT_TUNNEL_LIST}`);
-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);
@@ -20,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/remove.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const utils_1 = require("../../../utils");
-const commandAgentTunnelRemove = (0, utils_1.newCommand)('rm', texts_1.DESC_COMMAND_AGENT_TUNNEL_REMOVE);
-commandAgentTunnelRemove.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_AGENT_TUNNEL_REMOVE}`);
+const commandAgentTunnelRemove = (0, utils_1.newCommand)('rm', texts_1.DESC_COMMAND_AGENT_TUNNEL_REMOVE, { examples: texts_1.EXAMPLE_AGENT_TUNNEL_REMOVE });
 commandAgentTunnelRemove.argument('<id>', texts_1.OPTION_ID);
 commandAgentTunnelRemove.action(async (id) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;

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

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const utils_1 = require("../../../utils");
-const commandAgentTunnelStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_START);
-commandAgentTunnelStart.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_AGENT_TUNNEL_START}`);
+const commandAgentTunnelStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_AGENT_TUNNEL_START, { examples: texts_1.EXAMPLE_AGENT_TUNNEL_START });
 commandAgentTunnelStart.argument('<name>', texts_1.OPTION_NAME);
 commandAgentTunnelStart.action(async (name) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;

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

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const texts_1 = require("../../../texts");
 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);
-commandAgentTunnelStatus.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_AGENT_TUNNEL_STATUS}`);
+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) {
@@ -22,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);
             }
@@ -33,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/tunnel/tcp.js

@@ -7,11 +7,12 @@ const utils_1 = require("../../../utils");
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const tunnel_1 = require("../../../types/tunnel");
-const commandAgentTunnelTcp = (0, utils_1.getBasicCommandTcp)();
-commandAgentTunnelTcp.description(texts_1.DESC_COMMAND_TCP);
+const commandAgentTunnelTcp = (0, utils_1.getBasicCommandTcp)({
+    examples: (0, texts_1.EXAMPLE_TUNNEL_TCP)(true),
+});
+commandAgentTunnelTcp.description(texts_1.DESC_COMMAND_AGENT_TUNNEL_TCP);
 commandAgentTunnelTcp.option('-f, --follow', texts_1.OPTION_FOLLOW);
 commandAgentTunnelTcp.argument('[host:port]', texts_1.OPTION_TARGET);
-commandAgentTunnelTcp.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_TCP)(true)}`);
 commandAgentTunnelTcp.action(async (target, options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     const AgentSocketTunnel = require('../../../agent/socket/tunnel').default;

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

@@ -7,11 +7,12 @@ const utils_1 = require("../../../utils");
 const output_1 = __importDefault(require("../../../output"));
 const texts_1 = require("../../../texts");
 const tunnel_1 = require("../../../types/tunnel");
-const commandAgentTunnelTls = (0, utils_1.getBasicCommandTls)();
-commandAgentTunnelTls.description(texts_1.DESC_COMMAND_TLS);
+const commandAgentTunnelTls = (0, utils_1.getBasicCommandTls)({
+    examples: (0, texts_1.EXAMPLE_TUNNEL_TLS)(true),
+});
+commandAgentTunnelTls.description(texts_1.DESC_COMMAND_AGENT_TUNNEL_TLS);
 commandAgentTunnelTls.option('-f, --follow', texts_1.OPTION_FOLLOW);
 commandAgentTunnelTls.argument('[host:port]', texts_1.OPTION_TARGET);
-commandAgentTunnelTls.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_TLS)(true)}`);
 commandAgentTunnelTls.action(async (target, options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     const AgentSocketTunnel = require('../../../agent/socket/tunnel').default;

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

@@ -14,7 +14,17 @@ const status_1 = __importDefault(require("./tunnel/status"));
 const utils_1 = require("../../utils");
 const enable_1 = __importDefault(require("./tunnel/enable"));
 const disable_1 = __importDefault(require("./tunnel/disable"));
-const commandAgentTunnel = (0, utils_1.newCommand)('tunnel', texts_1.DESC_COMMAND_AGENT_TUNNEL);
+const commandAgentTunnel = (0, utils_1.newCommand)('tunnel', texts_1.DESC_COMMAND_AGENT_TUNNEL, {
+    examples: [
+        ...(0, texts_1.EXAMPLE_TUNNEL_HTTP)(true),
+        ...(0, texts_1.EXAMPLE_TUNNEL_TLS)(true),
+        ...(0, texts_1.EXAMPLE_TUNNEL_TCP)(true),
+        ...texts_1.EXAMPLE_AGENT_TUNNEL_START,
+        ...texts_1.EXAMPLE_AGENT_TUNNEL_LIST,
+        ...texts_1.EXAMPLE_AGENT_TUNNEL_STATUS,
+        ...texts_1.EXAMPLE_AGENT_TUNNEL_REMOVE,
+    ],
+});
 commandAgentTunnel.addCommand(tcp_1.default);
 commandAgentTunnel.addCommand(tls_1.default);
 commandAgentTunnel.addCommand(http_1.default);
@@ -24,11 +34,4 @@ commandAgentTunnel.addCommand(list_1.default);
 commandAgentTunnel.addCommand(status_1.default);
 commandAgentTunnel.addCommand(enable_1.default);
 commandAgentTunnel.addCommand(disable_1.default);
-commandAgentTunnel.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_HTTP)(true)}
-${(0, texts_1.EXAMPLE_TUNNEL_TLS)(true)}
-${(0, texts_1.EXAMPLE_TUNNEL_TCP)(true)}
-${texts_1.EXAMPLE_AGENT_TUNNEL_START}
-${texts_1.EXAMPLE_AGENT_TUNNEL_LIST}
-${texts_1.EXAMPLE_AGENT_TUNNEL_STATUS}
-${texts_1.EXAMPLE_AGENT_TUNNEL_REMOVE}`);
 exports.default = commandAgentTunnel;

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/composer/publish.js

@@ -12,7 +12,10 @@ const logger_1 = __importDefault(require("../../../logger"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = require("path");
 const uuid_1 = require("uuid");
-const commandArtifactComposerPublish = (0, utils_1.newCommand)('publish', texts_1.DESC_COMMAND_ARTIFACT_COMPOSER_PUBLISH);
+const commandArtifactComposerPublish = (0, utils_1.newCommand)('publish', texts_1.DESC_COMMAND_ARTIFACT_COMPOSER_PUBLISH, {
+    requiredScopes: [utils_1.REST_API_SCOPE.ARTIFACT_WRITE],
+    examples: texts_1.EXAMPLE_ARTIFACT_COMPOSER_PUBLISH,
+});
 commandArtifactComposerPublish.alias('pub');
 commandArtifactComposerPublish.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandArtifactComposerPublish.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
@@ -23,7 +26,6 @@ commandArtifactComposerPublish.option('--agent-note <note>', texts_1.OPTION_ARTI
 commandArtifactComposerPublish.option('--ignore <patterns>', texts_1.OPTION_ARTIFACT_IGNORE);
 commandArtifactComposerPublish.argument('<identifier>', texts_1.OPTION_ARTIFACT_ID);
 commandArtifactComposerPublish.argument('<directory>', texts_1.OPTION_ARTIFACT_COMPOSE_PUBLISH_PATH);
-commandArtifactComposerPublish.addHelpText('after', texts_1.EXAMPLE_ARTIFACT_COMPOSER_PUBLISH);
 commandArtifactComposerPublish.action(async (id, path, options) => {
     const dirPath = input_1.default.resolvePath(path);
     if (!fs_1.default.statSync(dirPath).isDirectory()) {

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

@@ -8,7 +8,10 @@ const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 const distro_1 = require("../../types/distro");
-const commandArtifactCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_ARTIFACT_CREATE);
+const commandArtifactCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_ARTIFACT_CREATE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.ARTIFACT_WRITE],
+    examples: texts_1.EXAMPLE_ARTIFACT_CREATE,
+});
 commandArtifactCreate.alias('add');
 commandArtifactCreate.option('-i, --identifier <identifier>', texts_1.OPT_COMMAND_ARTIFACT_CREATE_IDENTIFIER);
 commandArtifactCreate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
@@ -20,7 +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.addHelpText('after', texts_1.EXAMPLE_ARTIFACT_CREATE);
+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);
@@ -69,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;