@pitcher/cli-scripts 2.7.0 → 2.7.1

package/dist/src/commands/analytics.js

@@ -35,7 +35,7 @@ export function createAnalyticsCommand() {
         emitEnvelope(await runAnalyticsOrg({ ...options, quiet: globals.quiet }), globals);
     });
     withAuthFlags(cmd.command('instance'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
+        .option('--instance-id <id>', 'Instance ID (required)')
         .description('instance rollups (instance-admin or org-admin key required)')
         .action(async (options, command) => {
         const globals = command.optsWithGlobals();

package/dist/src/commands/canvases.js

@@ -50,7 +50,7 @@ export async function runCanvasesGet(opts, deps = {}) {
 export function createCanvasesCommand() {
     const cmd = new Command('canvases').description('read Pitcher canvases (presentations, sections, blocks)');
     withAuthFlags(cmd.command('list'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
+        .option('--instance-id <id>', 'Instance ID (required)')
         .option('--is-template', 'Only templates')
         .option('--is-section', 'Only sections')
         .option('--is-block', 'Only blocks (blocks are hidden unless this flag is set)')

package/dist/src/commands/dsrLanding.js

@@ -116,8 +116,8 @@ export async function runDsrLandingScaffold(opts, _deps = {}) {
 export function createDsrLandingCommand() {
     const cmd = new Command('dsr-landing').description('create/list DSR (Digital Sales Room) landing-page templates, and set one as default');
     withInstanceFlag(withAuthFlags(cmd.command('create')))
-        .requiredOption('--name <name>', 'Template name')
-        .requiredOption('--html-file <path>', `Path to the landing HTML (must contain ${REQUIRED_MARKER})`)
+        .option('--name <name>', 'Template name (required)')
+        .option('--html-file <path>', `Path to the landing HTML (required; must contain ${REQUIRED_MARKER})`)
         .option('--css-file <path>', 'Path to a CSS file for the template')
         .option('--merge-schema <json>', 'Merge schema array as inline JSON')
         .option('--language <lang>', 'Language code (max 10 chars)')
@@ -129,7 +129,7 @@ export function createDsrLandingCommand() {
         emitEnvelope(await runDsrLandingCreate({ ...options, quiet: globals.quiet }), globals);
     });
     withInstanceFlag(withAuthFlags(cmd.command('set-default')))
-        .requiredOption('--id <id>', 'Template ID')
+        .option('--id <id>', 'Template ID (required)')
         .action(async (options, command) => {
         const globals = command.optsWithGlobals();
         emitEnvelope(await runDsrLandingSetDefault({ ...options, quiet: globals.quiet }), globals);

package/dist/src/commands/emailTemplate.js

@@ -85,7 +85,7 @@ export async function runEmailTemplateScaffold(opts, _deps = {}) {
 export function createEmailTemplateCommand() {
     const cmd = new Command('email-template').description('create/list/get HTML email templates for the emails app');
     withInstanceFlag(withAuthFlags(cmd.command('create')))
-        .requiredOption('--name <name>', 'Template name')
+        .option('--name <name>', 'Template name (required)')
         .option('--body-file <path>', 'Path to an HTML file (inline CSS) used as the template body')
         .option('--subject <text>', 'Email subject (supports {{tokens}})')
         .option('--tags <json>', 'Tags object as inline JSON')
@@ -107,7 +107,7 @@ export function createEmailTemplateCommand() {
         emitEnvelope(await runEmailTemplateList({ ...options, quiet: globals.quiet }), globals);
     });
     withInstanceFlag(withAuthFlags(cmd.command('get')))
-        .requiredOption('--id <id>', 'Template ID')
+        .option('--id <id>', 'Template ID (required)')
         .action(async (options, command) => {
         const globals = command.optsWithGlobals();
         emitEnvelope(await runEmailTemplateGet({ ...options, quiet: globals.quiet }), globals);

package/dist/src/commands/files.js

@@ -119,7 +119,7 @@ export async function runFilesUpdate(opts, deps = {}) {
 export function createFilesCommand() {
     const cmd = new Command('files').description('manage Pitcher content files');
     withAuthFlags(cmd.command('list'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
+        .option('--instance-id <id>', 'Instance ID (required)')
         .option('--id-in <ids>', 'Comma-separated file IDs')
         .option('--tags <tags>', 'Comma-separated tags (filters via tags__in)')
         .option('--page <n>', 'Page number', (v) => parseInt(v, 10))
@@ -135,7 +135,7 @@ export function createFilesCommand() {
         emitEnvelope(await runFilesGet({ ...options, id, quiet: globals.quiet }), globals);
     });
     withAuthFlags(cmd.command('create'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
+        .option('--instance-id <id>', 'Instance ID (required)')
         .option('--name <name>', 'File name')
         .option('--folder-id <id>', 'Destination folder')
         .option('--file <path>', 'Local file to upload')

package/dist/src/commands/folders.js

@@ -83,7 +83,7 @@ export async function runFoldersUpdate(opts, deps = {}) {
 export function createFoldersCommand() {
     const cmd = new Command('folders').description('manage Pitcher content folders');
     withAuthFlags(cmd.command('list'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
+        .option('--instance-id <id>', 'Instance ID (required)')
         .option('--page <n>', 'Page number', (v) => parseInt(v, 10))
         .option('--page-size <n>', 'Page size (max 500)', (v) => parseInt(v, 10))
         .action(async (options, command) => {
@@ -99,8 +99,8 @@ export function createFoldersCommand() {
         emitEnvelope(await runFoldersGet({ ...options, id, quiet: globals.quiet }), globals);
     });
     withAuthFlags(cmd.command('create'))
-        .requiredOption('--name <name>', 'Folder name')
-        .requiredOption('--parent-folder-id <id>', 'Parent folder ID')
+        .option('--name <name>', 'Folder name (required)')
+        .option('--parent-folder-id <id>', 'Parent folder ID (required)')
         .option('--access-type <type>', 'public | restricted | personal')
         .option('--rules <json>', 'Smart-folder rules JSON array')
         .action(async (options, command) => {

package/dist/src/commands/search.js

@@ -25,8 +25,8 @@ export async function runSearch(opts, deps = {}) {
 }
 export function createSearchCommand() {
     return withAuthFlags(new Command('search').description('search content across an instance (files, canvases, users, apps)'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
-        .requiredOption('--query <text>', 'Search query')
+        .option('--instance-id <id>', 'Instance ID (required)')
+        .option('--query <text>', 'Search query (required)')
         .option('--include-expired', 'Include expired content')
         .action(async (options, command) => {
         const globals = command.optsWithGlobals();

package/dist/src/commands/tags.js

@@ -37,8 +37,8 @@ export async function runTagsList(opts, deps = {}) {
 export function createTagsCommand() {
     const cmd = new Command('tags').description('list tags in an instance (search term of >=3 chars required)');
     withAuthFlags(cmd.command('list'))
-        .requiredOption('--instance-id <id>', 'Instance ID')
-        .requiredOption('--search <text>', 'Search term (server requires at least 3 characters)')
+        .option('--instance-id <id>', 'Instance ID (required)')
+        .option('--search <text>', 'Search term (required; at least 3 characters)')
         .option('--type <type>', 'files | canvases')
         .option('--canvas-type <type>', 'Canvas type filter')
         .option('--include-hidden', 'Include hidden tags')

package/dist/src/commands/withInstance.d.ts

@@ -1,3 +1,8 @@
 import { Command } from 'commander';
-/** Attach the shared --instance-id flag to a (sub)command. */
+/**
+ * Attach the shared --instance-id flag to a (sub)command.
+ * Uses .option (not .requiredOption) so a missing flag flows through the
+ * command's in-run VALIDATION guard and yields the JSON envelope (exit 3),
+ * instead of commander aborting with plain text on stderr (exit 1).
+ */
 export declare function withInstanceFlag(c: Command): Command;

package/dist/src/commands/withInstance.js

@@ -1,4 +1,9 @@
-/** Attach the shared --instance-id flag to a (sub)command. */
+/**
+ * Attach the shared --instance-id flag to a (sub)command.
+ * Uses .option (not .requiredOption) so a missing flag flows through the
+ * command's in-run VALIDATION guard and yields the JSON envelope (exit 3),
+ * instead of commander aborting with plain text on stderr (exit 1).
+ */
 export function withInstanceFlag(c) {
-    return c.requiredOption('--instance-id <id>', 'Instance ID');
+    return c.option('--instance-id <id>', 'Instance ID (required)');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/cli-scripts",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "The Pitcher CLI for various tasks in its ecosystem.",
   "author": "Pitcher AG",
   "license": "MIT",