@disclosure-api/cli 0.0.1

package/dist/client.js

@@ -0,0 +1,170 @@
+import { DEFAULT_BASE_URL } from './catalog.js';
+export class ApiRequestError extends Error {
+    code;
+    status;
+    details;
+    rateLimit;
+    constructor(input) {
+        super(input.message);
+        this.name = 'ApiRequestError';
+        this.code = input.code;
+        this.status = input.status;
+        this.details = input.details;
+        this.rateLimit = input.rateLimit;
+    }
+}
+export class DisclosureApiClient {
+    baseUrl;
+    apiKey;
+    constructor(env = process.env) {
+        this.baseUrl = normalizeBaseUrl(env.DISCLOSURE_API_BASE_URL ?? DEFAULT_BASE_URL);
+        this.apiKey = env.DISCLOSURE_API_KEY;
+    }
+    async getJson(path, query, authRequired) {
+        const url = buildUrl(this.baseUrl, path, query);
+        const headers = {
+            accept: 'application/json'
+        };
+        if (authRequired) {
+            if (!this.apiKey) {
+                throw new ApiRequestError({
+                    code: 'missing_api_key',
+                    message: 'DISCLOSURE_API_KEY is required for this command. Set it to your Disclosure API bearer token.'
+                });
+            }
+            headers.authorization = `Bearer ${this.apiKey}`;
+        }
+        let response;
+        try {
+            response = await fetch(url, { headers });
+        }
+        catch (error) {
+            throw new ApiRequestError({
+                code: 'network_error',
+                message: error instanceof Error ? error.message : 'Network request failed'
+            });
+        }
+        const body = await readBody(response);
+        if (!response.ok) {
+            const apiError = parseApiError(body);
+            throw new ApiRequestError({
+                code: apiError.code,
+                message: apiError.message,
+                status: response.status,
+                details: apiError.details,
+                rateLimit: readRateLimitHeaders(response.headers)
+            });
+        }
+        return body;
+    }
+    async getAllPages(path, query, authRequired) {
+        const rows = [];
+        let pages = 0;
+        let nextOffset = typeof query.offset === 'number'
+            ? query.offset
+            : Number.parseInt(String(query.offset ?? '0'), 10);
+        const initialOffset = Number.isFinite(nextOffset) ? nextOffset : 0;
+        const pageQuery = { ...query };
+        for (;;) {
+            pageQuery.offset = nextOffset;
+            const page = (await this.getJson(path, pageQuery, authRequired));
+            pages += 1;
+            if (!Array.isArray(page.data)) {
+                throw new ApiRequestError({
+                    code: 'unexpected_response',
+                    message: 'Expected a paginated response with a data array while using --all.',
+                    details: { page }
+                });
+            }
+            rows.push(...page.data);
+            const pagination = page.pagination;
+            if (!pagination?.has_more ||
+                pagination.next_offset === null ||
+                pagination.next_offset === undefined) {
+                return {
+                    data: rows,
+                    pagination: {
+                        limit: pagination?.limit ?? parseNullableNumber(query.limit),
+                        offset: initialOffset,
+                        has_more: false,
+                        next_offset: null,
+                        total_retrieved: rows.length,
+                        pages
+                    }
+                };
+            }
+            if (pages > 1000) {
+                throw new ApiRequestError({
+                    code: 'pagination_limit_exceeded',
+                    message: 'Stopped after 1000 pages while following --all pagination.',
+                    details: { next_offset: pagination.next_offset }
+                });
+            }
+            nextOffset = pagination.next_offset;
+        }
+    }
+}
+function normalizeBaseUrl(value) {
+    const url = new URL(value);
+    url.hash = '';
+    url.search = '';
+    url.pathname = url.pathname.replace(/\/+$/, '');
+    if (url.pathname === '/v1') {
+        url.pathname = '';
+    }
+    return url.toString().replace(/\/+$/, '');
+}
+function buildUrl(baseUrl, path, query) {
+    const url = new URL(path.replace(/^\//, ''), `${baseUrl}/`);
+    for (const [key, value] of Object.entries(query)) {
+        url.searchParams.set(key, String(value));
+    }
+    return url;
+}
+async function readBody(response) {
+    const text = await response.text();
+    if (!text)
+        return null;
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return text;
+    }
+}
+function parseApiError(body) {
+    if (isRecord(body)) {
+        const error = body.error;
+        if (isRecord(error)) {
+            return {
+                code: typeof error.code === 'string' ? error.code : 'api_error',
+                message: typeof error.message === 'string' ? error.message : 'API request failed',
+                details: error.details
+            };
+        }
+    }
+    return {
+        code: 'api_error',
+        message: typeof body === 'string' ? body : 'API request failed',
+        details: body
+    };
+}
+function readRateLimitHeaders(headers) {
+    const output = {};
+    for (const name of ['ratelimit-limit', 'ratelimit-remaining', 'ratelimit-reset', 'retry-after']) {
+        const value = headers.get(name);
+        if (value)
+            output[name] = value;
+    }
+    return Object.keys(output).length ? output : undefined;
+}
+function parseNullableNumber(value) {
+    if (value === undefined)
+        return null;
+    const number = typeof value === 'number' ? value : Number.parseInt(String(value), 10);
+    return Number.isFinite(number) ? number : null;
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AA2BhD,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAChC,IAAI,CAAS;IACb,MAAM,CAAU;IAChB,OAAO,CAAW;IAClB,SAAS,CAA0B;IAE5C,YAAY,KAMX;QACA,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IAClC,CAAC;CACD;AAED,MAAM,OAAO,mBAAmB;IACtB,OAAO,CAAS;IACR,MAAM,CAAqB;IAE5C,YAAY,MAAyB,OAAO,CAAC,GAAG;QAC/C,IAAI,CAAC,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,uBAAuB,IAAI,gBAAgB,CAAC,CAAC;QACjF,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,kBAAkB,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,KAAkB,EAAE,YAAqB;QACpE,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,OAAO,GAA2B;YACvC,MAAM,EAAE,kBAAkB;SAC1B,CAAC;QAEF,IAAI,YAAY,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,eAAe,CAAC;oBACzB,IAAI,EAAE,iBAAiB;oBACvB,OAAO,EACN,8FAA8F;iBAC/F,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QACjD,CAAC;QAED,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACJ,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,eAAe,CAAC;gBACzB,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;aAC1E,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YAClB,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,IAAI,eAAe,CAAC;gBACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,SAAS,EAAE,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC;aACjD,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,CAAC,WAAW,CAChB,IAAY,EACZ,KAAkB,EAClB,YAAqB;QAErB,MAAM,IAAI,GAAc,EAAE,CAAC;QAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,UAAU,GACb,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;YAC/B,CAAC,CAAC,KAAK,CAAC,MAAM;YACd,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;QAE/B,SAAS,CAAC;YACT,SAAS,CAAC,MAAM,GAAG,UAAU,CAAC;YAC9B,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,CAAC,CAAiB,CAAC;YACjF,KAAK,IAAI,CAAC,CAAC;YAEX,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,eAAe,CAAC;oBACzB,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EAAE,oEAAoE;oBAC7E,OAAO,EAAE,EAAE,IAAI,EAAE;iBACjB,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAExB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YACnC,IACC,CAAC,UAAU,EAAE,QAAQ;gBACrB,UAAU,CAAC,WAAW,KAAK,IAAI;gBAC/B,UAAU,CAAC,WAAW,KAAK,SAAS,EACnC,CAAC;gBACF,OAAO;oBACN,IAAI,EAAE,IAAI;oBACV,UAAU,EAAE;wBACX,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC;wBAC5D,MAAM,EAAE,aAAa;wBACrB,QAAQ,EAAE,KAAK;wBACf,WAAW,EAAE,IAAI;wBACjB,eAAe,EAAE,IAAI,CAAC,MAAM;wBAC5B,KAAK;qBACL;iBACD,CAAC;YACH,CAAC;YAED,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBAClB,MAAM,IAAI,eAAe,CAAC;oBACzB,IAAI,EAAE,2BAA2B;oBACjC,OAAO,EAAE,4DAA4D;oBACrE,OAAO,EAAE,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE;iBAChD,CAAC,CAAC;YACJ,CAAC;YAED,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC;QACrC,CAAC;IACF,CAAC;CACD;AAED,SAAS,gBAAgB,CAAC,KAAa;IACtC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3B,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC;IACd,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAChB,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChD,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC5B,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe,EAAE,IAAY,EAAE,KAAkB;IAClE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,GAAG,OAAO,GAAG,CAAC,CAAC;IAC5D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,QAAkB;IACzC,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,IAAI,CAAC;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAY,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED,SAAS,aAAa,CAAC,IAAa;IACnC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO;gBACN,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW;gBAC/D,OAAO,EAAE,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB;gBACjF,OAAO,EAAE,KAAK,CAAC,OAAO;aACtB,CAAC;QACH,CAAC;IACF,CAAC;IACD,OAAO;QACN,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB;QAC/D,OAAO,EAAE,IAAI;KACb,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAgB;IAC7C,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,CAAC;QACjG,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACxD,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IAC1C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrC,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACtF,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC/B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACpD,CAAC"}

package/dist/help.d.ts

@@ -0,0 +1,56 @@
+import { type CommandSpec } from './catalog.js';
+export declare function rootHelp(): string;
+export declare function commandHelp(command: CommandSpec): string;
+export declare function helpCatalogJson(): {
+    name: string;
+    binary: string;
+    version: string;
+    defaultBaseUrl: string;
+    env: ({
+        name: string;
+        requiredForProtectedCommands: boolean;
+        description: string;
+        required?: undefined;
+        default?: undefined;
+    } | {
+        name: string;
+        required: boolean;
+        default: string;
+        description: string;
+        requiredForProtectedCommands?: undefined;
+    })[];
+    output: {
+        success: string;
+        error: string;
+        pagination: string;
+    };
+    agentGuidance: string[];
+    commands: {
+        id: string;
+        command: string;
+        description: string;
+        authRequired: boolean;
+        list: boolean;
+        endpoint: {
+            method: string;
+            path: string;
+        };
+        positionals: {
+            name: string;
+            label: string;
+            required: boolean;
+            description: string;
+            pathParam: string | undefined;
+            queryParam: string | undefined;
+        }[];
+        flags: {
+            name: string;
+            kind: string;
+            valueName: string | undefined;
+            apiName: string | undefined;
+            description: string;
+        }[];
+        examples: readonly string[];
+        notes: readonly string[];
+    }[];
+};

package/dist/help.js

@@ -0,0 +1,200 @@
+import { CLI_NAME, CLI_VERSION, COMMANDS, DEFAULT_BASE_URL, commandName } from './catalog.js';
+export function rootHelp() {
+    const commands = COMMANDS.map((command) => `  ${pad(commandName(command), 36)} ${command.summary}`).join('\n');
+    return `${CLI_NAME} ${CLI_VERSION}
+
+Agent-friendly CLI for the Disclosure API.
+
+Usage:
+  ${CLI_NAME} <command> [args] [flags]
+  ${CLI_NAME} --help
+  ${CLI_NAME} --version
+  ${CLI_NAME} help --json
+  ${CLI_NAME} help <command>
+
+Environment:
+  DISCLOSURE_API_KEY       Required for all protected /v1 commands.
+  DISCLOSURE_API_BASE_URL  Optional API origin. Defaults to ${DEFAULT_BASE_URL}.
+
+Output contract:
+  Success writes JSON to stdout.
+  List commands support --format jsonl to write one data row per line.
+  Errors write a JSON error envelope to stderr and exit non-zero.
+  Use --all on list commands to follow pagination until has_more is false.
+
+For coding agents:
+  Prefer --format json unless a streaming row format is easier to consume.
+  Use --all only when a complete dataset is needed.
+  Avoid --include-text unless full extracted filing text is required.
+  On non-zero exit, parse stderr JSON and inspect error.code and error.details.
+  Cite returned SEC/source URLs when relevant.
+
+Commands:
+${commands}
+
+Examples:
+  ${CLI_NAME} status
+  ${CLI_NAME} companies search AAPL --limit 5
+  ${CLI_NAME} filings list --ticker AAPL --form-type 8-K --format jsonl
+  ${CLI_NAME} filings sections 0000320193-24-000037 --item-code 2.02
+  ${CLI_NAME} help filings list
+`;
+}
+export function commandHelp(command) {
+    const usage = buildUsage(command);
+    const positionals = command.positionals?.length
+        ? `\nArguments:\n${command.positionals
+            .map((arg) => `  ${pad(arg.label, 22)} ${arg.description}`)
+            .join('\n')}\n`
+        : '';
+    const flags = renderFlags(command);
+    const examples = command.examples.map((example) => `  ${example}`).join('\n');
+    const notes = command.notes?.length
+        ? `\nNotes:\n${command.notes.map((note) => `  ${note}`).join('\n')}\n`
+        : '';
+    return `${CLI_NAME} ${commandName(command)}
+
+${command.summary}
+
+${command.description}
+
+Usage:
+  ${usage}
+
+Auth:
+  ${command.authRequired ? 'Requires DISCLOSURE_API_KEY.' : 'No API key required.'}
+
+Endpoint:
+  GET ${command.endpoint}
+
+Output:
+  Success writes JSON to stdout.
+  ${command.list
+        ? 'This list command supports --format jsonl and --all pagination.'
+        : 'This command supports --format json only.'}
+  Errors write JSON to stderr and exit non-zero.
+${positionals}${flags}${notes}
+Examples:
+${examples}
+`;
+}
+export function helpCatalogJson() {
+    return {
+        name: '@disclosure-api/cli',
+        binary: CLI_NAME,
+        version: CLI_VERSION,
+        defaultBaseUrl: DEFAULT_BASE_URL,
+        env: [
+            {
+                name: 'DISCLOSURE_API_KEY',
+                requiredForProtectedCommands: true,
+                description: 'Bearer token for protected Disclosure API commands.'
+            },
+            {
+                name: 'DISCLOSURE_API_BASE_URL',
+                required: false,
+                default: DEFAULT_BASE_URL,
+                description: 'API origin override. A trailing /v1 is accepted and normalized.'
+            }
+        ],
+        output: {
+            success: 'JSON to stdout. List commands may use JSONL with --format jsonl.',
+            error: 'JSON error envelope to stderr with a non-zero exit code.',
+            pagination: '--all follows pagination.has_more and pagination.next_offset on list commands.'
+        },
+        agentGuidance: [
+            'Prefer --format json unless JSONL row streaming is easier.',
+            'Use --all only when a complete dataset is required.',
+            'Avoid --include-text unless full extracted source text is needed.',
+            'On non-zero exit, parse stderr JSON and inspect error.code and error.details.',
+            'Cite returned SEC/source URLs when relevant.'
+        ],
+        commands: COMMANDS.map((command) => ({
+            id: command.id,
+            command: commandName(command),
+            description: command.description,
+            authRequired: command.authRequired,
+            list: command.list,
+            endpoint: {
+                method: 'GET',
+                path: command.endpoint
+            },
+            positionals: command.positionals?.map((arg) => ({
+                name: arg.name,
+                label: arg.label,
+                required: arg.required,
+                description: arg.description,
+                pathParam: arg.pathParam,
+                queryParam: arg.queryParam
+            })) ?? [],
+            flags: [...renderOutputFlagJson(command), ...(command.flags?.map(flagJson) ?? [])],
+            examples: command.examples,
+            notes: command.notes ?? []
+        }))
+    };
+}
+function buildUsage(command) {
+    const args = command.positionals?.map((arg) => arg.label).join(' ');
+    return [CLI_NAME, commandName(command), args, '[flags]'].filter(Boolean).join(' ');
+}
+function renderFlags(command) {
+    const flags = [...outputFlags(command), ...(command.flags ?? [])];
+    if (!flags.length)
+        return '';
+    return `Flags:\n${flags.map(formatFlag).join('\n')}\n`;
+}
+function outputFlags(command) {
+    return [
+        {
+            name: 'format',
+            apiName: '',
+            kind: 'string',
+            valueName: command.list ? 'json|jsonl' : 'json',
+            description: command.list
+                ? 'Output format. Defaults to json.'
+                : 'Output format. Only json is supported.'
+        },
+        ...(command.list
+            ? [
+                {
+                    name: 'all',
+                    apiName: '',
+                    kind: 'boolean-string',
+                    description: 'Follow pagination until has_more is false.'
+                }
+            ]
+            : []),
+        {
+            name: 'help',
+            apiName: '',
+            kind: 'boolean-string',
+            description: 'Show help for this command.'
+        }
+    ];
+}
+function renderOutputFlagJson(command) {
+    return outputFlags(command).map((flag) => ({
+        name: `--${flag.name}`,
+        kind: flag.name === 'all' || flag.name === 'help' ? 'boolean' : flag.kind,
+        valueName: flag.valueName,
+        apiName: flag.apiName || undefined,
+        description: flag.description
+    }));
+}
+function flagJson(flag) {
+    return {
+        name: `--${flag.name}`,
+        kind: flag.kind,
+        valueName: flag.valueName,
+        apiName: flag.apiName,
+        description: flag.description
+    };
+}
+function formatFlag(flag) {
+    const label = flag.valueName ? `--${flag.name} <${flag.valueName}>` : `--${flag.name}`;
+    return `  ${pad(label, 30)} ${flag.description}`;
+}
+function pad(value, width) {
+    return value.length >= width ? value : `${value}${' '.repeat(width - value.length)}`;
+}
+//# sourceMappingURL=help.js.map

package/dist/help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,WAAW,EAGX,MAAM,cAAc,CAAC;AAEtB,MAAM,UAAU,QAAQ;IACvB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAC5B,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CACpE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,OAAO,GAAG,QAAQ,IAAI,WAAW;;;;;IAK9B,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;;;;8DAIkD,gBAAgB;;;;;;;;;;;;;;;;EAgB5E,QAAQ;;;IAGN,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;CACX,CAAC;AACF,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAoB;IAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,MAAM;QAC9C,CAAC,CAAC,iBAAiB,OAAO,CAAC,WAAW;aACnC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;aAC1D,IAAI,CAAC,IAAI,CAAC,IAAI;QACjB,CAAC,CAAC,EAAE,CAAC;IACN,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM;QAClC,CAAC,CAAC,aAAa,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;QACtE,CAAC,CAAC,EAAE,CAAC;IAEN,OAAO,GAAG,QAAQ,IAAI,WAAW,CAAC,OAAO,CAAC;;EAEzC,OAAO,CAAC,OAAO;;EAEf,OAAO,CAAC,WAAW;;;IAGjB,KAAK;;;IAGL,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC,sBAAsB;;;QAG1E,OAAO,CAAC,QAAQ;;;;IAKtB,OAAO,CAAC,IAAI;QACX,CAAC,CAAC,iEAAiE;QACnE,CAAC,CAAC,2CACJ;;EAEC,WAAW,GAAG,KAAK,GAAG,KAAK;;EAE3B,QAAQ;CACT,CAAC;AACF,CAAC;AAED,MAAM,UAAU,eAAe;IAC9B,OAAO;QACN,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,WAAW;QACpB,cAAc,EAAE,gBAAgB;QAChC,GAAG,EAAE;YACJ;gBACC,IAAI,EAAE,oBAAoB;gBAC1B,4BAA4B,EAAE,IAAI;gBAClC,WAAW,EAAE,qDAAqD;aAClE;YACD;gBACC,IAAI,EAAE,yBAAyB;gBAC/B,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,gBAAgB;gBACzB,WAAW,EAAE,iEAAiE;aAC9E;SACD;QACD,MAAM,EAAE;YACP,OAAO,EAAE,kEAAkE;YAC3E,KAAK,EAAE,0DAA0D;YACjE,UAAU,EAAE,gFAAgF;SAC5F;QACD,aAAa,EAAE;YACd,4DAA4D;YAC5D,qDAAqD;YACrD,mEAAmE;YACnE,+EAA+E;YAC/E,8CAA8C;SAC9C;QACD,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACpC,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;YAC7B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,QAAQ,EAAE;gBACT,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,OAAO,CAAC,QAAQ;aACtB;YACD,WAAW,EACV,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAClC,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,UAAU,EAAE,GAAG,CAAC,UAAU;aAC1B,CAAC,CAAC,IAAI,EAAE;YACV,KAAK,EAAE,CAAC,GAAG,oBAAoB,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAClF,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;SAC1B,CAAC,CAAC;KACH,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,OAAoB;IACvC,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpE,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,WAAW,CAAC,OAAoB;IACxC,MAAM,KAAK,GAAG,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAC7B,OAAO,WAAW,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACxD,CAAC;AAED,SAAS,WAAW,CAAC,OAAoB;IACxC,OAAO;QACN;YACC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM;YAC/C,WAAW,EAAE,OAAO,CAAC,IAAI;gBACxB,CAAC,CAAC,kCAAkC;gBACpC,CAAC,CAAC,wCAAwC;SAC3C;QACD,GAAG,CAAC,OAAO,CAAC,IAAI;YACf,CAAC,CAAC;gBACA;oBACC,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,EAAE;oBACX,IAAI,EAAE,gBAAyB;oBAC/B,WAAW,EAAE,4CAA4C;iBACzD;aACD;YACF,CAAC,CAAC,EAAE,CAAC;QACN;YACC,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,6BAA6B;SAC1C;KACD,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAoB;IACjD,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;QACzE,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,SAAS;QAClC,WAAW,EAAE,IAAI,CAAC,WAAW;KAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,IAAc;IAC/B,OAAO;QACN,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE;QACtB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC7B,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAc;IACjC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;IACvF,OAAO,KAAK,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,GAAG,CAAC,KAAa,EAAE,KAAa;IACxC,OAAO,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;AACtF,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};