bdy 1.25.2-stage → 1.25.4-dev

package/distTs/src/command/distro/route.js

@@ -10,15 +10,18 @@ const list_1 = __importDefault(require("./route/list"));
 const get_1 = __importDefault(require("./route/get"));
 const delete_1 = __importDefault(require("./route/delete"));
 const update_1 = __importDefault(require("./route/update"));
-const commandDistroRoute = (0, utils_1.newCommand)('route', texts_1.DESC_COMMAND_ROUTE);
+const commandDistroRoute = (0, utils_1.newCommand)('route', texts_1.DESC_COMMAND_ROUTE, {
+    examples: [
+        ...texts_1.EXAMPLE_ROUTE_CREATE,
+        ...texts_1.EXAMPLE_ROUTE_UPDATE,
+        ...texts_1.EXAMPLE_ROUTE_LIST,
+        ...texts_1.EXAMPLE_ROUTE_GET,
+        ...texts_1.EXAMPLE_ROUTE_DELETE,
+    ],
+});
 commandDistroRoute.addCommand(create_1.default);
 commandDistroRoute.addCommand(update_1.default);
 commandDistroRoute.addCommand(list_1.default);
 commandDistroRoute.addCommand(get_1.default);
 commandDistroRoute.addCommand(delete_1.default);
-commandDistroRoute.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ROUTE_CREATE}
-${texts_1.EXAMPLE_ROUTE_UPDATE}
-${texts_1.EXAMPLE_ROUTE_LIST}
-${texts_1.EXAMPLE_ROUTE_GET}
-${texts_1.EXAMPLE_ROUTE_DELETE}`);
 exports.default = commandDistroRoute;

package/distTs/src/command/distro/update.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 commandDistroUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_DISTRO_UPDATE);
+const commandDistroUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_DISTRO_UPDATE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.DISTRIBUTION_WRITE],
+    examples: texts_1.EXAMPLE_DISTRO_UPDATE,
+});
 commandDistroUpdate.alias('edit');
 commandDistroUpdate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDistroUpdate.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
@@ -19,7 +22,7 @@ commandDistroUpdate.option('--agent-note <note>', texts_1.OPT_COMMAND_DISTRO_AGE
 commandDistroUpdate.option('--enable', texts_1.OPT_COMMAND_DISTRO_ENABLE);
 commandDistroUpdate.option('--disable', texts_1.OPT_COMMAND_DISTRO_DISABLE);
 commandDistroUpdate.argument('<identifier>', texts_1.OPT_COMMAND_DISTRO_IDENTIFIER);
-commandDistroUpdate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_DISTRO_UPDATE}`);
+commandDistroUpdate.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDistroUpdate.action(async (identifier, options) => {
     if (options.enable && options.disable) {
         output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_ENABLE_DISABLE);
@@ -57,6 +60,10 @@ commandDistroUpdate.action(async (identifier, options) => {
         output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
     }
     const result = await client.updateDistribution(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, body);
+    if (options.format === 'json') {
+        output_1.default.json(result);
+        output_1.default.exitNormal();
+    }
     output_1.default.identifier(result.identifier);
     output_1.default.cyan(result.html_url);
     output_1.default.green(texts_1.TXT_COMMAND_DISTRO_UPDATED);

package/distTs/src/command/distro.js

@@ -11,21 +11,24 @@ const get_1 = __importDefault(require("./distro/get"));
 const list_1 = __importDefault(require("./distro/list"));
 const route_1 = __importDefault(require("./distro/route"));
 const update_1 = __importDefault(require("./distro/update"));
-const commandDistro = (0, utils_1.newCommand)('distro', texts_1.DESC_COMMAND_DISTRO);
+const commandDistro = (0, utils_1.newCommand)('distro', texts_1.DESC_COMMAND_DISTRO, {
+    examples: [
+        ...texts_1.EXAMPLE_DISTRO_CREATE,
+        ...texts_1.EXAMPLE_DISTRO_UPDATE,
+        ...texts_1.EXAMPLE_DISTRO_LIST,
+        ...texts_1.EXAMPLE_DISTRO_GET,
+        ...texts_1.EXAMPLE_DISTRO_DELETE,
+        ...texts_1.EXAMPLE_ROUTE_CREATE,
+        ...texts_1.EXAMPLE_ROUTE_UPDATE,
+        ...texts_1.EXAMPLE_ROUTE_LIST,
+        ...texts_1.EXAMPLE_ROUTE_GET,
+        ...texts_1.EXAMPLE_ROUTE_DELETE,
+    ],
+});
 commandDistro.addCommand(create_1.default);
 commandDistro.addCommand(update_1.default);
 commandDistro.addCommand(list_1.default);
 commandDistro.addCommand(get_1.default);
 commandDistro.addCommand(delete_1.default);
 commandDistro.addCommand(route_1.default);
-commandDistro.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_DISTRO_CREATE}
-${texts_1.EXAMPLE_DISTRO_UPDATE}
-${texts_1.EXAMPLE_DISTRO_LIST}
-${texts_1.EXAMPLE_DISTRO_GET}
-${texts_1.EXAMPLE_DISTRO_DELETE}
-${texts_1.EXAMPLE_ROUTE_CREATE}
-${texts_1.EXAMPLE_ROUTE_UPDATE}
-${texts_1.EXAMPLE_ROUTE_LIST}
-${texts_1.EXAMPLE_ROUTE_GET}
-${texts_1.EXAMPLE_ROUTE_DELETE}`);
 exports.default = commandDistro;

package/distTs/src/command/domain/search.js

@@ -20,12 +20,16 @@ const sort = (arr, sort) => {
         return 0;
     });
 };
-const commandDomainSearch = (0, utils_1.newCommand)('search', texts_1.DESC_COMMAND_DOMAIN_SEARCH);
+const commandDomainSearch = (0, utils_1.newCommand)('search', texts_1.DESC_COMMAND_DOMAIN_SEARCH, {
+    helpText: texts_1.HELP_DOMAIN_SEARCH_JSON,
+    examples: texts_1.EXAMPLE_DOMAIN_SEARCH,
+});
 commandDomainSearch.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDomainSearch.option('-d, --tld <tld...>', texts_1.OPT_COMMAND_DOMAIN_BUY_TLD);
 commandDomainSearch.option('-s, --sort <name|price>', texts_1.OPT_COMMAND_DOMAIN_SORT);
 commandDomainSearch.option('-a, --only-available', texts_1.OPT_COMMAND_DOMAIN_ONLY_AVAILABLE);
 commandDomainSearch.argument('[domain|prompt]', texts_1.OPT_COMMAND_DOMAIN_PHRASE);
+commandDomainSearch.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDomainSearch.action(async (text, options) => {
     const onlyAvailable = options.onlyAvailable;
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -38,12 +42,17 @@ commandDomainSearch.action(async (text, options) => {
     if (!prompt) {
         output_1.default.exitError(texts_1.TXT_COMMAND_DOMAIN_PROMPT_REQUIRED);
     }
-    output_1.default.arrowSign();
-    output_1.default.normal(`Searching...`);
+    let searchResponse = null;
+    let claimsResponse = null;
+    if (options.format !== 'json') {
+        output_1.default.arrowSign();
+        output_1.default.normal(`Searching...`);
+    }
     const matched = [];
     if ((0, utils_1.isValidDomain)(prompt)) {
         const subdomain = (0, utils_1.getSubdomain)(prompt);
         const claims = await client.domainClaimable(workspace, subdomain);
+        claimsResponse = claims;
         const claimable = claims.domains.find((c) => `${subdomain}.${c.domain}` === prompt);
         if (claimable && (!onlyAvailable || claimable.available)) {
             matched.push({
@@ -54,6 +63,7 @@ commandDomainSearch.action(async (text, options) => {
         }
         else {
             const search = await client.domainSearch(workspace, [prompt]);
+            searchResponse = search;
             const buyable = search.domains.find((d) => d.name === prompt);
             if (buyable &&
                 (!onlyAvailable || buyable.available)) {
@@ -67,6 +77,7 @@ commandDomainSearch.action(async (text, options) => {
     }
     else if ((0, utils_1.isValidSubdomain)(prompt)) {
         const claims = await client.domainClaimable(workspace, prompt);
+        claimsResponse = claims;
         const domains = [];
         const popularTlds = (0, utils_1.getPopularTlds)();
         const searchTlds = tlds.length > 0 ? tlds : popularTlds;
@@ -74,13 +85,15 @@ commandDomainSearch.action(async (text, options) => {
             domains.push(`${prompt}.${tld}`);
         });
         const search = await client.domainSearch(workspace, domains);
-        search.domains = search.domains.sort((a, b) => {
-            const aTld = (0, utils_1.getDomainTld)(a.name);
-            const bTld = (0, utils_1.getDomainTld)(b.name);
-            const aIdx = popularTlds.indexOf(aTld);
-            const bIdx = popularTlds.indexOf(bTld);
-            return aIdx < bIdx ? -1 : 1;
-        });
+        searchResponse = search;
+        if (options.format !== 'json')
+            search.domains = search.domains.sort((a, b) => {
+                const aTld = (0, utils_1.getDomainTld)(a.name);
+                const bTld = (0, utils_1.getDomainTld)(b.name);
+                const aIdx = popularTlds.indexOf(aTld);
+                const bIdx = popularTlds.indexOf(bTld);
+                return aIdx < bIdx ? -1 : 1;
+            });
         claims.domains.forEach((c) => {
             if (!onlyAvailable || c.available) {
                 const name = `${prompt}.${c.domain}`;
@@ -103,6 +116,14 @@ commandDomainSearch.action(async (text, options) => {
         });
     }
     const result = await client.domainSuggest(workspace, prompt, tlds, 5);
+    if (options.format === 'json') {
+        output_1.default.json({
+            search: searchResponse,
+            claims: claimsResponse,
+            suggestions: result,
+        });
+        output_1.default.exitNormal();
+    }
     output_1.default.clearPreviousLine();
     let hasAny = false;
     if (matched.length > 0) {

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

@@ -8,7 +8,7 @@ const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 const distro_1 = require("../../types/distro");
-const commandEnvironmentCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_ENVIRONMENT_CREATE);
+const commandEnvironmentCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_ENVIRONMENT_CREATE, { examples: texts_1.EXAMPLE_ENVIRONMENT_CREATE });
 commandEnvironmentCreate.alias('add');
 commandEnvironmentCreate.option('-i, --identifier <identifier>', texts_1.OPTION_ENVIRONMENT_CREATE_IDENTIFIER);
 commandEnvironmentCreate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
@@ -20,7 +20,7 @@ commandEnvironmentCreate.option('--icon <icon>', texts_1.OPTION_ENVIRONMENT_ICON
 commandEnvironmentCreate.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
 commandEnvironmentCreate.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
 commandEnvironmentCreate.argument('[name]', texts_1.OPTION_ENVIRONMENT_NAME);
-commandEnvironmentCreate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ENVIRONMENT_CREATE}`);
+commandEnvironmentCreate.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandEnvironmentCreate.action(async (name, options) => {
     const humanId = require('human-id').default;
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -65,6 +65,10 @@ commandEnvironmentCreate.action(async (name, options) => {
     }
     const client = input_1.default.restApiTokenClient();
     const result = await client.createEnvironment(workspace, data);
+    if (options.format === 'json') {
+        output_1.default.json(result);
+        output_1.default.exitNormal();
+    }
     output_1.default.exitSuccess((0, texts_1.TXT_ENVIRONMENT_CREATED)(result.identifier, result.html_url));
 });
 exports.default = commandEnvironmentCreate;

package/distTs/src/command/environment/delete.js

@@ -7,13 +7,12 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const input_1 = __importDefault(require("../../input"));
-const commandEnvironmentDelete = (0, utils_1.newCommand)('delete', texts_1.DESC_COMMAND_ENVIRONMENT_DELETE);
+const commandEnvironmentDelete = (0, utils_1.newCommand)('delete', texts_1.DESC_COMMAND_ENVIRONMENT_DELETE, { examples: texts_1.EXAMPLE_ENVIRONMENT_DELETE });
 commandEnvironmentDelete.alias('rm');
 commandEnvironmentDelete.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandEnvironmentDelete.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandEnvironmentDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandEnvironmentDelete.argument('<identifier>', texts_1.OPTION_ENVIRONMENT_IDENTIFIER);
-commandEnvironmentDelete.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ENVIRONMENT_DELETE}`);
 commandEnvironmentDelete.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const client = input_1.default.restApiTokenClient();

package/distTs/src/command/environment/get.js

@@ -7,12 +7,13 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const input_1 = __importDefault(require("../../input"));
-const commandEnvironmentGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_ENVIRONMENT_GET);
+const commandEnvironmentGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_ENVIRONMENT_GET, {
+    examples: texts_1.EXAMPLE_ENVIRONMENT_GET,
+});
 commandEnvironmentGet.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandEnvironmentGet.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandEnvironmentGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandEnvironmentGet.argument('<identifier>', texts_1.OPTION_ENVIRONMENT_IDENTIFIER);
-commandEnvironmentGet.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ENVIRONMENT_GET}`);
 commandEnvironmentGet.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const client = input_1.default.restApiTokenClient();

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

@@ -8,13 +8,12 @@ const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const input_1 = __importDefault(require("../../input"));
 const distro_1 = require("../../types/distro");
-const commandEnvironmentList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_ENVIRONMENT_LIST);
+const commandEnvironmentList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_ENVIRONMENT_LIST, { examples: texts_1.EXAMPLE_ENVIRONMENT_LIST });
 commandEnvironmentList.alias('ls');
 commandEnvironmentList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandEnvironmentList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandEnvironmentList.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
 commandEnvironmentList.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandEnvironmentList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ENVIRONMENT_LIST}`);
 commandEnvironmentList.action(async (options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project, true);

package/distTs/src/command/environment/update.js

@@ -7,7 +7,7 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandEnvironmentUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_ENVIRONMENT_UPDATE);
+const commandEnvironmentUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_ENVIRONMENT_UPDATE, { examples: texts_1.EXAMPLE_ENVIRONMENT_UPDATE });
 commandEnvironmentUpdate.alias('edit');
 commandEnvironmentUpdate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandEnvironmentUpdate.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
@@ -18,7 +18,7 @@ commandEnvironmentUpdate.option('--icon <icon>', texts_1.OPTION_ENVIRONMENT_ICON
 commandEnvironmentUpdate.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
 commandEnvironmentUpdate.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
 commandEnvironmentUpdate.argument('<identifier>', texts_1.OPTION_ENVIRONMENT_IDENTIFIER);
-commandEnvironmentUpdate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_ENVIRONMENT_UPDATE}`);
+commandEnvironmentUpdate.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandEnvironmentUpdate.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const body = {};
@@ -54,6 +54,10 @@ commandEnvironmentUpdate.action(async (identifier, options) => {
     const environment_id = await input_1.default.environmentId(client, workspace, identifier, options, 
     /* strictProject */ true);
     const result = await client.updateEnvironment(workspace, environment_id, body);
+    if (options.format === 'json') {
+        output_1.default.json(result);
+        output_1.default.exitNormal();
+    }
     output_1.default.exitSuccess((0, texts_1.TXT_ENVIRONMENT_UPDATED)(result.identifier, result.html_url));
 });
 exports.default = commandEnvironmentUpdate;

package/distTs/src/command/mcp.js

@@ -11,10 +11,11 @@ const output_1 = __importDefault(require("../output"));
 const logErr = (msg) => {
     process.stderr.write(`${msg}\n`);
 };
-const commandMcp = (0, utils_1.newCommand)('mcp', texts_1.DESC_COMMAND_MCP);
+const commandMcp = (0, utils_1.newCommand)('mcp', texts_1.DESC_COMMAND_MCP, {
+    helpText: `\n${(0, texts_1.HELP_COMMAND_MCP)(utils_1.MCP_TOOL_CATEGORIES.map(({ name, description }) => `    ${name.padEnd(12)}${description}`).join('\n'))}`,
+});
 commandMcp.skipPre = true;
 commandMcp.option('-t, --tools <list>', texts_1.OPT_COMMAND_MCP_TOOLS);
-commandMcp.addHelpText('after', `\n${(0, texts_1.HELP_COMMAND_MCP)(utils_1.MCP_TOOL_CATEGORIES.map(({ name, description }) => `    ${name.padEnd(12)}${description}`).join('\n'))}`);
 commandMcp.action(async (options) => {
     // The proxy is meant to be spawned by an MCP client with piped stdio. Run
     // interactively it would sit waiting for JSON-RPC on stdin - show the help

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

@@ -7,7 +7,10 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_PIPELINE_CREATE);
+const commandPipelineCreate = (0, utils_1.newCommand)('create', texts_1.DESC_COMMAND_PIPELINE_CREATE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_WRITE],
+    examples: texts_1.EXAMPLE_PIPELINE_CREATE,
+});
 commandPipelineCreate.alias('add');
 commandPipelineCreate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineCreate.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
@@ -15,7 +18,6 @@ commandPipelineCreate.option('-n, --name <name>', texts_1.OPTION_PIPELINE_NAME);
 commandPipelineCreate.option('-i, --identifier <identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineCreate.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandPipelineCreate.option('--yaml <content|@path>', texts_1.OPTION_PIPELINE_YAML);
-commandPipelineCreate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_CREATE}`);
 commandPipelineCreate.action(async (options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/delete.js

@@ -7,13 +7,15 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineDelete = (0, utils_1.newCommand)('delete', texts_1.DESC_COMMAND_PIPELINE_DELETE);
+const commandPipelineDelete = (0, utils_1.newCommand)('delete', texts_1.DESC_COMMAND_PIPELINE_DELETE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_MANAGE],
+    examples: texts_1.EXAMPLE_PIPELINE_DELETE,
+});
 commandPipelineDelete.alias('rm');
 commandPipelineDelete.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineDelete.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandPipelineDelete.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
-commandPipelineDelete.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_DELETE}`);
 commandPipelineDelete.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/get.js

@@ -7,12 +7,14 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_PIPELINE_GET);
+const commandPipelineGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_PIPELINE_GET, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_GET,
+});
 commandPipelineGet.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineGet.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandPipelineGet.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
-commandPipelineGet.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_GET}`);
 commandPipelineGet.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

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

@@ -7,14 +7,16 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_PIPELINE_LIST);
+const commandPipelineList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_PIPELINE_LIST, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_LIST,
+});
 commandPipelineList.alias('ls');
 commandPipelineList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineList.option('--page <number>', texts_1.OPTION_REST_API_PAGE, '1');
 commandPipelineList.option('--per-page <number>', texts_1.OPTION_REST_API_PER_PAGE, '10');
 commandPipelineList.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandPipelineList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_LIST}`);
 commandPipelineList.action(async (options) => {
     const page = input_1.default.restApiPage(options.page);
     const perPage = input_1.default.restApiPerPage(options.perPage);

package/distTs/src/command/pipeline/run/approve.js

@@ -8,7 +8,11 @@ const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
 const pipeline_1 = require("../../../types/pipeline");
-const commandPipelineRunApprove = (0, utils_1.newCommand)('approve', texts_1.DESC_COMMAND_PIPELINE_RUN_APPLY);
+const commandPipelineRunApprove = (0, utils_1.newCommand)('approve', texts_1.DESC_COMMAND_PIPELINE_RUN_APPLY, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_RUN],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_APPLY,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunApprove.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunApprove.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunApprove.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
@@ -18,8 +22,6 @@ commandPipelineRunApprove.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENT
 commandPipelineRunApprove.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
 commandPipelineRunApprove.argument('<action-run-id>', texts_1.OPTION_PIPELINE_RUN_ACTION_ID);
 commandPipelineRunApprove.option('-v,--variable <variables...>', texts_1.OPTION_RUN_VAR);
-commandPipelineRunApprove.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_APPLY}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 commandPipelineRunApprove.action(async (identifier, runId, runActionId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/run/cancel.js

@@ -7,7 +7,11 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
-const commandPipelineRunCancel = (0, utils_1.newCommand)('cancel', texts_1.DESC_COMMAND_PIPELINE_RUN_CANCEL);
+const commandPipelineRunCancel = (0, utils_1.newCommand)('cancel', texts_1.DESC_COMMAND_PIPELINE_RUN_CANCEL, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_RUN],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_CANCEL,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunCancel.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunCancel.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunCancel.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
@@ -15,8 +19,6 @@ commandPipelineRunCancel.option('--no-follow', texts_1.OPTION_PIPELINE_RUN_NO_FO
 commandPipelineRunCancel.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandPipelineRunCancel.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineRunCancel.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
-commandPipelineRunCancel.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_CANCEL}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 commandPipelineRunCancel.action(async (identifier, runId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/run/list.js

@@ -7,7 +7,10 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
-const commandPipelineRunList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_PIPELINE_RUN_LIST);
+const commandPipelineRunList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_PIPELINE_RUN_LIST, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_LIST,
+});
 commandPipelineRunList.alias('ls');
 commandPipelineRunList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
@@ -15,7 +18,6 @@ commandPipelineRunList.option('--page <number>', texts_1.OPTION_REST_API_PAGE, '
 commandPipelineRunList.option('--per-page <number>', texts_1.OPTION_REST_API_PER_PAGE, '10');
 commandPipelineRunList.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandPipelineRunList.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
-commandPipelineRunList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_LIST}`);
 commandPipelineRunList.action(async (identifier, options) => {
     const page = input_1.default.restApiPage(options.page);
     const perPage = input_1.default.restApiPerPage(options.perPage);

package/distTs/src/command/pipeline/run/logs.js

@@ -7,7 +7,11 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
-const commandPipelineRunLogs = (0, utils_1.newCommand)('logs', texts_1.DESC_COMMAND_PIPELINE_RUN_LOGS);
+const commandPipelineRunLogs = (0, utils_1.newCommand)('logs', texts_1.DESC_COMMAND_PIPELINE_RUN_LOGS, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_LOGS,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunLogs.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunLogs.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunLogs.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
@@ -15,8 +19,6 @@ commandPipelineRunLogs.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSO
 commandPipelineRunLogs.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineRunLogs.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
 commandPipelineRunLogs.argument('<action-run-id>', texts_1.OPTION_PIPELINE_RUN_ACTION_ID);
-commandPipelineRunLogs.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_LOGS}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 commandPipelineRunLogs.action(async (identifier, runId, runActionId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/run/retry.js

@@ -7,7 +7,11 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
-const commandPipelineRunRetry = (0, utils_1.newCommand)('retry', texts_1.DESC_COMMAND_PIPELINE_RUN_RETRY);
+const commandPipelineRunRetry = (0, utils_1.newCommand)('retry', texts_1.DESC_COMMAND_PIPELINE_RUN_RETRY, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_RUN],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_RETRY,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunRetry.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunRetry.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunRetry.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
@@ -15,8 +19,6 @@ commandPipelineRunRetry.option('--no-follow', texts_1.OPTION_PIPELINE_RUN_NO_FOL
 commandPipelineRunRetry.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandPipelineRunRetry.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineRunRetry.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
-commandPipelineRunRetry.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_RETRY}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 commandPipelineRunRetry.action(async (identifier, runId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/run/start.js

@@ -10,7 +10,11 @@ const input_1 = __importDefault(require("../../../input"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const path_1 = require("path");
 const client_1 = require("../../../api/client");
-const commandPipelineRunStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_PIPELINE_RUN_START);
+const commandPipelineRunStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_PIPELINE_RUN_START, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_RUN],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_START,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunStart.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunStart.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunStart.option('-b, --branch <branch>', texts_1.OPTION_PIPELINE_RUN_BRANCH);
@@ -37,8 +41,6 @@ commandPipelineRunStart.option('--no-follow', texts_1.OPTION_PIPELINE_RUN_NO_FOL
 commandPipelineRunStart.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandPipelineRunStart.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineRunStart.usage('<identifier> [options]');
-commandPipelineRunStart.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_START}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 /**
  * Collect the files to upload from a payload directory. Symlinks are followed,
  * both files and directories, and following them out of the payload directory

package/distTs/src/command/pipeline/run/status.js

@@ -7,7 +7,11 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
 const output_1 = __importDefault(require("../../../output"));
-const commandPipelineRunStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_PIPELINE_RUN_STATUS);
+const commandPipelineRunStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_PIPELINE_RUN_STATUS, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_RUN_STATUS,
+    helpText: texts_1.HELP_PIPELINE_RUN_JSONL,
+});
 commandPipelineRunStatus.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineRunStatus.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineRunStatus.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
@@ -15,8 +19,6 @@ commandPipelineRunStatus.option('--no-follow', texts_1.OPTION_PIPELINE_RUN_NO_FO
 commandPipelineRunStatus.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandPipelineRunStatus.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineRunStatus.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
-commandPipelineRunStatus.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_STATUS}
-${texts_1.EXAMPLE_PIPELINE_RUN_JSONL}`);
 commandPipelineRunStatus.action(async (identifier, runId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/run.js

@@ -12,7 +12,17 @@ const cancel_1 = __importDefault(require("./run/cancel"));
 const retry_1 = __importDefault(require("./run/retry"));
 const list_1 = __importDefault(require("./run/list"));
 const approve_1 = __importDefault(require("./run/approve"));
-const commandPipelineRun = (0, utils_1.newCommand)('run', texts_1.DESC_COMMAND_PIPELINE_RUN);
+const commandPipelineRun = (0, utils_1.newCommand)('run', texts_1.DESC_COMMAND_PIPELINE_RUN, {
+    examples: [
+        ...texts_1.EXAMPLE_PIPELINE_RUN_START,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_STATUS,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_LOGS,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_CANCEL,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_RETRY,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_APPLY,
+        ...texts_1.EXAMPLE_PIPELINE_RUN_LIST,
+    ],
+});
 commandPipelineRun.addCommand(start_1.default);
 commandPipelineRun.addCommand(status_1.default);
 commandPipelineRun.addCommand(logs_1.default);
@@ -20,12 +30,4 @@ commandPipelineRun.addCommand(cancel_1.default);
 commandPipelineRun.addCommand(retry_1.default);
 commandPipelineRun.addCommand(approve_1.default);
 commandPipelineRun.addCommand(list_1.default);
-commandPipelineRun.addHelpText('after', `
-EXAMPLES:${texts_1.EXAMPLE_PIPELINE_RUN_START}
-${texts_1.EXAMPLE_PIPELINE_RUN_STATUS}
-${texts_1.EXAMPLE_PIPELINE_RUN_LOGS}
-${texts_1.EXAMPLE_PIPELINE_RUN_CANCEL}
-${texts_1.EXAMPLE_PIPELINE_RUN_RETRY}
-${texts_1.EXAMPLE_PIPELINE_RUN_APPLY}
-${texts_1.EXAMPLE_PIPELINE_RUN_LIST}`);
 exports.default = commandPipelineRun;

package/distTs/src/command/pipeline/update.js

@@ -7,13 +7,15 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_PIPELINE_UPDATE);
+const commandPipelineUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_PIPELINE_UPDATE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_WRITE],
+    examples: texts_1.EXAMPLE_PIPELINE_UPDATE,
+});
 commandPipelineUpdate.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineUpdate.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineUpdate.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
 commandPipelineUpdate.argument('<yaml|@path>', texts_1.OPTION_PIPELINE_YAML);
 commandPipelineUpdate.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandPipelineUpdate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_UPDATE}`);
 commandPipelineUpdate.action(async (identifier, y, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/pipeline/yaml.js

@@ -7,13 +7,15 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandPipelineYaml = (0, utils_1.newCommand)('yaml', texts_1.DESC_COMMAND_PIPELINE_YAML);
+const commandPipelineYaml = (0, utils_1.newCommand)('yaml', texts_1.DESC_COMMAND_PIPELINE_YAML, {
+    requiredScopes: [utils_1.REST_API_SCOPE.PIPELINE_READ],
+    examples: texts_1.EXAMPLE_PIPELINE_YML,
+});
 commandPipelineYaml.hideVersionUpdate = true;
 commandPipelineYaml.alias('yml');
 commandPipelineYaml.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPipelineYaml.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPipelineYaml.argument('<identifier>', texts_1.OPTION_PIPELINE_IDENTIFIER);
-commandPipelineYaml.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_PIPELINE_YML}`);
 commandPipelineYaml.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);