@nocobase/cli 2.1.0-beta.2 → 2.1.0-beta.20

package/dist/commands/logs.js

@@ -0,0 +1,90 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../lib/app-runtime.js';
+import { run } from '../lib/run-npm.js';
+import { printInfo } from '../lib/ui.js';
+function formatLogsFailure(envName, message) {
+    return [
+        `Couldn't show logs for "${envName}".`,
+        'Check that the saved local app or Docker container still exists on this machine, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class Logs extends Command {
+    static description = 'Show NocoBase logs for the selected env. Local npm/git installs use pm2 logs, and Docker installs use docker logs.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --tail 200',
+        '<%= config.bin %> <%= command.id %> --env app1 --no-follow',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to inspect logs for. Defaults to the current env when omitted',
+        }),
+        tail: Flags.integer({
+            description: 'Number of recent log lines to show before following',
+            default: 100,
+            min: 0,
+        }),
+        follow: Flags.boolean({
+            char: 'f',
+            description: 'Keep streaming new log lines',
+            default: true,
+            allowNo: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Logs);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'remote') {
+            this.error([
+                `Can't show runtime logs for "${runtime.envName}" from this machine.`,
+                'This env only has an API connection, so there is no saved local app or Docker container to read logs from.',
+                'Connect it to a local checkout or reinstall it with npm, git, or Docker if you want CLI-managed logs.',
+            ].join('\n'));
+        }
+        const tail = String(flags.tail ?? 100);
+        const follow = flags.follow !== false;
+        printInfo(follow
+            ? `Showing logs for "${runtime.envName}" (press Ctrl+C to stop).`
+            : `Showing recent logs for "${runtime.envName}".`);
+        try {
+            if (runtime.kind === 'docker') {
+                const dockerArgs = ['logs', '--tail', tail];
+                if (follow) {
+                    dockerArgs.push('--follow');
+                }
+                dockerArgs.push(runtime.containerName);
+                await run('docker', dockerArgs, {
+                    errorName: 'docker logs',
+                    stdio: 'inherit',
+                });
+                return;
+            }
+            const localArgs = ['pm2', 'logs', '--lines', tail];
+            if (!follow) {
+                localArgs.push('--nostream');
+            }
+            await runLocalNocoBaseCommand(runtime, localArgs, {
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(formatLogsFailure(runtime.envName, message));
+        }
+    }
+}

package/dist/commands/pm/disable.js

@@ -0,0 +1,63 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runDockerNocoBaseCommand, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+export default class PmDisable extends Command {
+    static args = {
+        packages: Args.string({
+            required: true,
+            multiple: true,
+            description: 'Plugin package name(s) to disable (e.g. `@nocobase/plugin-sample`). Pass one or more names as separate arguments.',
+        }),
+    };
+    static description = 'Disable one or more plugins in the selected env (npm/git runs locally, Docker runs inside the saved app container)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> @nocobase/plugin-sample',
+        '<%= config.bin %> <%= command.id %> @nocobase/plugin-a @nocobase/plugin-b',
+        '<%= config.bin %> <%= command.id %> -e local @nocobase/plugin-sample',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name (from `nb env` / `nb install`). Defaults to the current env when omitted',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PmDisable);
+        const packages = args.packages;
+        if (!Array.isArray(packages) || packages.length === 0) {
+            this.error('Pass at least one plugin package name.');
+        }
+        const runtime = await resolveManagedAppRuntime(flags.env);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(flags.env));
+        }
+        if (runtime.kind === 'local') {
+            try {
+                await runLocalNocoBaseCommand(runtime, ['pm', 'disable', ...packages]);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        if (runtime.kind === 'docker') {
+            try {
+                await runDockerNocoBaseCommand(runtime.containerName, ['pm', 'disable', ...packages]);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        await this.config.runCommand('api:pm:disable', ['--await-response', '--filter-by-tk', packages.join(',')]);
+    }
+}

package/dist/commands/pm/enable.js

@@ -0,0 +1,63 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runDockerNocoBaseCommand, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+export default class PmEnable extends Command {
+    static args = {
+        packages: Args.string({
+            required: true,
+            multiple: true,
+            description: 'Plugin package name(s) to enable (e.g. `@nocobase/plugin-sample`). Pass one or more names as separate arguments.',
+        }),
+    };
+    static description = 'Enable one or more plugins in the selected env (npm/git runs locally, Docker runs inside the saved app container)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> @nocobase/plugin-sample',
+        '<%= config.bin %> <%= command.id %> @nocobase/plugin-a @nocobase/plugin-b',
+        '<%= config.bin %> <%= command.id %> -e local @nocobase/plugin-sample',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name (from `nb env` / `nb install`). Defaults to the current env when omitted',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PmEnable);
+        const packages = args.packages;
+        if (!Array.isArray(packages) || packages.length === 0) {
+            this.error('Pass at least one plugin package name.');
+        }
+        const runtime = await resolveManagedAppRuntime(flags.env);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(flags.env));
+        }
+        if (runtime.kind === 'local') {
+            try {
+                await runLocalNocoBaseCommand(runtime, ['pm', 'enable', ...packages]);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        if (runtime.kind === 'docker') {
+            try {
+                await runDockerNocoBaseCommand(runtime.containerName, ['pm', 'enable', ...packages]);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        await this.config.runCommand('api:pm:enable', ['--await-response', '--filter-by-tk', packages.join(',')]);
+    }
+}

package/dist/commands/pm/list.js

@@ -0,0 +1,54 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runDockerNocoBaseCommand, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+export default class PmList extends Command {
+    static args = {};
+    static summary = 'List plugins for the selected env';
+    static description = 'List installed plugins in the selected env (npm/git runs locally, Docker runs inside the saved app container, remote envs fall back to the API)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> -e local',
+        '<%= config.bin %> <%= command.id %> -e local-docker',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name (from `nb env` / `nb install`). Defaults to the current env when omitted',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(PmList);
+        const runtime = await resolveManagedAppRuntime(flags.env);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(flags.env));
+        }
+        if (runtime.kind === 'local') {
+            try {
+                await runLocalNocoBaseCommand(runtime, ['pm', 'list']);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        if (runtime.kind === 'docker') {
+            try {
+                await runDockerNocoBaseCommand(runtime.containerName, ['pm', 'list']);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                this.error(message);
+            }
+            return;
+        }
+        await this.config.runCommand('api:pm:list', ['--mode=summary']);
+    }
+}

package/dist/commands/prompts-stages.js

@@ -0,0 +1,150 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { runPromptCatalog, } from "../lib/prompt-catalog.js";
+import { applyCliLocale, CLI_LOCALE_FLAG_DESCRIPTION, CLI_LOCALE_FLAG_OPTIONS, } from "../lib/cli-locale.js";
+import { runPromptCatalogWebUI } from "../lib/prompt-web-ui.js";
+import PromptsTest from "./prompts-test.js";
+function buildWebUiStagesFromTestPrompts(c) {
+    return [
+        {
+            sectionTitle: 'Step 1',
+            sectionDescription: 'intro, file, name, and boolean',
+            catalog: {
+                intro1: c.intro1,
+                file: c.file,
+                text: c.text,
+                boolean: c.boolean,
+            },
+        },
+        {
+            sectionTitle: 'Step 2',
+            sectionDescription: 'select, then the option1 run hook',
+            catalog: {
+                select: c.select,
+                onOption1: c.onOption1,
+            },
+        },
+        {
+            sectionTitle: 'Step 3',
+            sectionDescription: 'password, integer, and outro',
+            catalog: {
+                password: c.password,
+                integer: c.integer,
+                outro1: c.outro1,
+            },
+        },
+    ];
+}
+/**
+ * With `--ui`: `runPromptCatalogWebUI` using `stages` + `sectionTitle`, then
+ * `runPromptCatalog` on the same catalog as `prompts-test`. Without `--ui`, same terminal behavior
+ * as `prompts-test` (handy for comparing).
+ */
+export default class PromptsStages extends Command {
+    static hidden = true;
+    static args = {
+        file: Args.string({ description: 'file to read', required: false }),
+    };
+    static description = 'Demo: with --ui, `runPromptCatalogWebUI` with `stages` (section headings in the form); without --ui, same as `prompts-test`. The submitted preset runs through the same `PromptsTest.prompts` catalog as `prompts-test`.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>  # same terminal flow as `prompts-test`',
+        '<%= config.bin %> <%= command.id %> --ui  # `runPromptCatalogWebUI` with `stages` + `sectionTitle`',
+        '<%= config.bin %> <%= command.id %> -y ./README.md -p secret --ui',
+    ];
+    static flags = {
+        ui: Flags.boolean({
+            description: 'Open the localhost form: `runPromptCatalogWebUI` with `stages` and `sectionTitle` (vs `prompts-test --ui`, which uses one `catalog`). Without --ui, behavior matches `prompts-test` (Clack in TTY / presets).',
+            default: false,
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Accept defaults only in the terminal (no Clack after submit); same semantics as `prompts-test` when used with the submitted or default preset.',
+            default: false,
+        }),
+        locale: Flags.string({
+            description: CLI_LOCALE_FLAG_DESCRIPTION,
+            options: CLI_LOCALE_FLAG_OPTIONS,
+        }),
+        file: Flags.string({
+            char: 'f',
+            description: 'Merged into initialValues.file (default for the text prompt when set)',
+        }),
+        text: Flags.string({
+            char: 't',
+            description: 'Merged into initialValues.text (default for the text prompt when set)',
+        }),
+        boolean: Flags.boolean({
+            char: 'b',
+            description: 'Merged into initialValues.boolean (default for confirm when set)',
+            allowNo: true,
+        }),
+        select: Flags.string({
+            char: 's',
+            description: 'Merged into initialValues.select (default for select when set)',
+            options: ['option1', 'option2', 'option3'],
+        }),
+        password: Flags.string({
+            char: 'p',
+            description: 'Merged into initialValues.password (required when -y / non-TTY if password is required)',
+        }),
+        integer: Flags.integer({
+            char: 'i',
+            description: 'Merged into initialValues.integer (default for integer prompt when set)',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PromptsStages);
+        applyCliLocale(flags.locale);
+        let presetValues = this.buildPresetValuesFromParsed(args, flags);
+        if (flags.ui) {
+            presetValues = await runPromptCatalogWebUI({
+                stages: buildWebUiStagesFromTestPrompts(PromptsTest.prompts),
+                values: presetValues,
+                pageTitle: 'nb prompts-stages — Web UI',
+                documentHeading: 'nb prompts-stages — `stages` demo',
+                onServerStart: ({ host, port, url }) => {
+                    this.log(`Local Web UI (multi-stage) ready — ${url} (listening on ${host}:${port}). Submit the form in the browser to continue.`);
+                },
+                onOpenBrowserError: (url, err) => {
+                    this.log(`Open this URL in a browser: ${url} (${err instanceof Error ? err.message : String(err)})`);
+                },
+            });
+        }
+        const results = await runPromptCatalog(PromptsTest.prompts, {
+            initialValues: {},
+            values: presetValues,
+            yes: flags.yes || flags.ui,
+        });
+        this.log(JSON.stringify(results, null, 2));
+    }
+    buildPresetValuesFromParsed(args, flags) {
+        const preset = {};
+        const file = args.file ?? flags.file;
+        if (file !== undefined) {
+            preset.file = file;
+        }
+        if (flags.text !== undefined) {
+            preset.text = flags.text;
+        }
+        if (flags.boolean !== undefined) {
+            preset.boolean = flags.boolean;
+        }
+        if (flags.select !== undefined) {
+            preset.select = flags.select;
+        }
+        if (flags.password !== undefined) {
+            preset.password = flags.password;
+        }
+        if (flags.integer !== undefined) {
+            preset.integer = flags.integer;
+        }
+        return preset;
+    }
+}

package/dist/commands/prompts-test.js

@@ -0,0 +1,181 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import * as p from '@clack/prompts';
+import { Args, Command, Flags } from '@oclif/core';
+import { runPromptCatalog, } from "../lib/prompt-catalog.js";
+import { applyCliLocale, CLI_LOCALE_FLAG_DESCRIPTION, CLI_LOCALE_FLAG_OPTIONS, } from "../lib/cli-locale.js";
+import { runPromptCatalogWebUI, } from "../lib/prompt-web-ui.js";
+export default class PromptsTest extends Command {
+    static hidden = true;
+    static args = {
+        file: Args.string({ description: 'file to read', required: false }),
+    };
+    static description = 'Demo: declarative `prompts` catalog + `initialValues` + `yesInitialValues` / per-block `yesInitialValue`; runner is `runPromptCatalog`.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> -t Ada --boolean',
+        '<%= config.bin %> <%= command.id %> -y',
+        '<%= config.bin %> <%= command.id %> -y ./README.md -p secret',
+        '<%= config.bin %> <%= command.id %> --ui',
+    ];
+    static flags = {
+        ui: Flags.boolean({
+            description: 'Open a browser to configure the same parameters in a form (served only on 127.0.0.1). Uses `runPromptCatalogWebUI` with this command’s `prompts` catalog. Submit to continue; then `runPromptCatalog` runs in this terminal with the submitted preset.',
+            default: false,
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Accept defaults only (no prompts); uses `yesInitialValues` merged over `initialValues`, then per-block `yesInitialValue`. Same as non-TTY.',
+            default: false,
+        }),
+        locale: Flags.string({
+            description: CLI_LOCALE_FLAG_DESCRIPTION,
+            options: CLI_LOCALE_FLAG_OPTIONS,
+        }),
+        file: Flags.string({
+            char: 'f',
+            description: 'Merged into initialValues.file (default for the text prompt when set)',
+        }),
+        text: Flags.string({
+            char: 't',
+            description: 'Merged into initialValues.text (default for the text prompt when set)',
+        }),
+        boolean: Flags.boolean({
+            char: 'b',
+            description: 'Merged into initialValues.boolean (default for confirm when set)',
+            allowNo: true,
+        }),
+        select: Flags.string({
+            char: 's',
+            description: 'Merged into initialValues.select (default for select when set)',
+            options: ['option1', 'option2', 'option3'],
+        }),
+        password: Flags.string({
+            char: 'p',
+            description: 'Merged into initialValues.password (required when -y / non-TTY if password is required)',
+        }),
+        integer: Flags.integer({
+            char: 'i',
+            description: 'Merged into initialValues.integer (default for integer prompt when set)',
+        }),
+    };
+    static prompts = {
+        intro1: {
+            type: 'intro',
+            title: 'Welcome to the prompts test!',
+        },
+        file: {
+            type: 'text',
+            message: 'File to read',
+            initialValue: '',
+            placeholder: 'Enter the file to read',
+            yesInitialValue: 'package.json',
+            required: true,
+        },
+        text: {
+            type: 'text',
+            message: 'What is your name?',
+            initialValue: 'world',
+            placeholder: 'Your name',
+            /**
+             * Example: async validation (Clack re-prompts; Web UI returns 400 on submit with this message).
+             */
+            validate: async (v) => {
+                if (String(v).trim().length < 2) {
+                    return 'Name must be at least 2 characters';
+                }
+                return undefined;
+            },
+        },
+        boolean: {
+            type: 'boolean',
+            message: 'Do you want to continue?',
+            initialValue: true,
+        },
+        select: {
+            type: 'select',
+            message: 'Select an option',
+            options: ['option1', 'option2', 'option3'],
+            initialValue: 'option1',
+            yesInitialValue: 'option2',
+        },
+        onOption1: {
+            type: 'run',
+            when: (values) => values.select === 'option1',
+            run: (values) => {
+                p.log.info(`run block: select is option1 (current keys: ${Object.keys(values).join(', ')})`);
+            },
+        },
+        password: {
+            type: 'password',
+            message: 'Enter your password',
+            yesInitialValue: 'demo-secret',
+            required: true,
+        },
+        integer: {
+            type: 'integer',
+            message: 'Enter an integer',
+            initialValue: 0,
+            placeholder: 'e.g. 42',
+            hidden: (values) => values.select === 'option1',
+        },
+        outro1: {
+            type: 'outro',
+            message: 'Done.',
+        },
+    };
+    async run() {
+        const { args, flags } = await this.parse(PromptsTest);
+        applyCliLocale(flags.locale);
+        let presetValues = this.buildPresetValuesFromParsed(args, flags);
+        if (flags.ui) {
+            presetValues = await runPromptCatalogWebUI(PromptsTest.prompts, {
+                values: presetValues,
+                pageTitle: 'nb prompts-test — UI',
+                documentHeading: 'nb prompts-test',
+                onServerStart: ({ host, port, url }) => {
+                    this.log(`Local Web UI ready — ${url} (listening on ${host}:${port}). Submit the form in the browser to continue.`);
+                },
+                onOpenBrowserError: (url, err) => {
+                    this.log(`Open this URL in a browser: ${url} (${err instanceof Error ? err.message : String(err)})`);
+                },
+            });
+        }
+        const results = await runPromptCatalog(PromptsTest.prompts, {
+            initialValues: {},
+            values: presetValues,
+            yes: flags.yes || flags.ui,
+        });
+        this.log(JSON.stringify(results, null, 2));
+    }
+    /** Map oclif parse result into `values` presets: each key here skips that prompt (no Clack UI). */
+    buildPresetValuesFromParsed(args, flags) {
+        const preset = {};
+        const file = args.file ?? flags.file;
+        if (file !== undefined) {
+            preset.file = file;
+        }
+        if (flags.text !== undefined) {
+            preset.text = flags.text;
+        }
+        if (flags.boolean !== undefined) {
+            preset.boolean = flags.boolean;
+        }
+        if (flags.select !== undefined) {
+            preset.select = flags.select;
+        }
+        if (flags.password !== undefined) {
+            preset.password = flags.password;
+        }
+        if (flags.integer !== undefined) {
+            preset.integer = flags.integer;
+        }
+        return preset;
+    }
+}