@nocobase/cli 2.1.0-beta.35 → 2.1.0-beta.37

package/README.md

@@ -61,7 +61,7 @@ When creating a new app, it can also install NocoBase AI coding skills
 (`nocobase/skills`) globally.
 
 Use `--skip-skills` if the skills are managed separately, or when running in CI
-or offline environments where `nb init` should not install or update them.
+or offline environments where `nb init` should not install them.
 
 ### Non-Interactive Setup
 

package/README.zh-CN.md

@@ -55,7 +55,7 @@ nb init --ui
 
 `nb init` 可以连接已有的 NocoBase 应用，也可以安装一个新的 NocoBase 应用。创建新应用时，还可以全局安装 NocoBase AI coding skills (`nocobase/skills`)。
 
-如果已经自行管理 skills，或在 CI、离线环境中运行，不希望 `nb init` 安装或更新 skills，可以传入 `--skip-skills`。
+如果已经自行管理 skills，或在 CI、离线环境中运行，不希望 `nb init` 安装 skills，可以传入 `--skip-skills`。
 
 ### 非交互式初始化
 

package/bin/run.js

@@ -4,6 +4,7 @@ import { spawnSync } from 'node:child_process';
 import fs from 'node:fs';
 import { createRequire } from 'node:module';
 import path from 'node:path';
+import pc from 'picocolors';
 import { fileURLToPath, pathToFileURL } from 'node:url';
 import { normalizeNodeOptions, normalizeSessionEnv } from './session-env.js';
 
@@ -130,6 +131,6 @@ try {
   flush();
 } catch (error) {
   const message = formatCliEntryError(error, process.argv.slice(2));
-  console.error(message);
-  process.exitCode = 1;
+  console.error(pc.red(message));
+  process.exit(1);
 }

package/dist/commands/app/upgrade.js

@@ -24,6 +24,18 @@ const APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS = 5_000;
 function trimValue(value) {
     return String(value ?? '').trim();
 }
+function pushOptionalEnvArg(args, key, value) {
+    if (typeof value === 'string') {
+        if (!value) {
+            return;
+        }
+        args.push('-e', `${key}=${value}`);
+        return;
+    }
+    if (typeof value === 'boolean') {
+        args.push('-e', `${key}=${String(value)}`);
+    }
+}
 function formatAppUrl(port) {
     const value = trimValue(port);
     return value ? `http://127.0.0.1:${value}` : undefined;
@@ -262,10 +274,13 @@ export default class AppUpgrade extends Command {
             persistDownloadVersion: requestedVersion || undefined,
         };
     }
-    static buildLocalDownloadArgv(runtime, downloadVersion) {
+    static buildLocalDownloadArgv(runtime, downloadVersion, options) {
         const argv = ['-y', '--no-intro', '--source', runtime.source, '--replace'];
         const gitUrl = readEnvValue(runtime.env, 'gitUrl');
         const npmRegistry = readEnvValue(runtime.env, 'npmRegistry');
+        if (options?.verbose) {
+            argv.push('--verbose');
+        }
         argv.push('--version', downloadVersion, '--output-dir', runtime.projectRoot);
         if (gitUrl) {
             argv.push('--git-url', gitUrl);
@@ -284,18 +299,12 @@ export default class AppUpgrade extends Command {
         }
         return argv;
     }
-    static buildDockerDownloadArgv(runtime, plan) {
-        const argv = [
-            '-y',
-            '--no-intro',
-            '--source',
-            'docker',
-            '--replace',
-            '--docker-registry',
-            plan.dockerRegistry,
-            '--version',
-            plan.downloadVersion,
-        ];
+    static buildDockerDownloadArgv(runtime, plan, options) {
+        const argv = ['-y', '--no-intro'];
+        if (options?.verbose) {
+            argv.push('--verbose');
+        }
+        argv.push('--source', 'docker', '--replace', '--docker-registry', plan.dockerRegistry, '--version', plan.downloadVersion);
         const dockerPlatform = normalizeDockerPlatform(runtime.env.config.dockerPlatform);
         if (dockerPlatform) {
             argv.push('--docker-platform', dockerPlatform);
@@ -329,6 +338,11 @@ export default class AppUpgrade extends Command {
         const dbDatabase = readEnvValue(runtime.env, 'dbDatabase');
         const dbUser = readEnvValue(runtime.env, 'dbUser');
         const dbPassword = readEnvValue(runtime.env, 'dbPassword');
+        const dbSchema = readEnvValue(runtime.env, 'dbSchema');
+        const dbTablePrefix = readEnvValue(runtime.env, 'dbTablePrefix');
+        const dbUnderscored = typeof runtime.env.config.dbUnderscored === 'boolean'
+            ? runtime.env.config.dbUnderscored
+            : undefined;
         const networkName = trimValue(runtime.dockerNetworkName || runtime.workspaceName);
         const missing = [];
         if (!networkName) {
@@ -384,7 +398,11 @@ export default class AppUpgrade extends Command {
         if (envFile) {
             args.push('--env-file', envFile);
         }
-        args.push('-e', `APP_KEY=${appKey}`, '-e', `DB_DIALECT=${dbDialect}`, '-e', `DB_HOST=${dbHost}`, '-e', `DB_PORT=${dbPort}`, '-e', `DB_DATABASE=${dbDatabase}`, '-e', `DB_USER=${dbUser}`, '-e', `DB_PASSWORD=${dbPassword}`, '-e', `TZ=${timeZone}`, '-v', `${storagePath}:${DOCKER_APP_STORAGE_DESTINATION}`, imageRef);
+        args.push('-e', `APP_KEY=${appKey}`, '-e', `DB_DIALECT=${dbDialect}`, '-e', `DB_HOST=${dbHost}`, '-e', `DB_PORT=${dbPort}`, '-e', `DB_DATABASE=${dbDatabase}`, '-e', `DB_USER=${dbUser}`, '-e', `DB_PASSWORD=${dbPassword}`, '-e', `TZ=${timeZone}`, '-v', `${storagePath}:${DOCKER_APP_STORAGE_DESTINATION}`);
+        pushOptionalEnvArg(args, 'DB_SCHEMA', dbSchema || undefined);
+        pushOptionalEnvArg(args, 'DB_TABLE_PREFIX', dbTablePrefix || undefined);
+        pushOptionalEnvArg(args, 'DB_UNDERSCORED', dbUnderscored);
+        args.push(imageRef);
         return {
             containerName: runtime.containerName,
             networkName,
@@ -422,7 +440,9 @@ export default class AppUpgrade extends Command {
         if (!flags['skip-code-update'] && (runtime.source === 'npm' || runtime.source === 'git')) {
             startTask(`Refreshing NocoBase files for "${runtime.envName}" from the saved ${runtime.source} source...`);
             try {
-                await runCommand('source:download', AppUpgrade.buildLocalDownloadArgv(runtime, downloadVersion));
+                await runCommand('source:download', AppUpgrade.buildLocalDownloadArgv(runtime, downloadVersion, {
+                    verbose: flags.verbose,
+                }));
                 succeedTask(`NocoBase files are up to date for "${runtime.envName}".`);
             }
             catch (error) {
@@ -468,7 +488,9 @@ export default class AppUpgrade extends Command {
             const plan = await AppUpgrade.buildDockerUpgradePlan(runtime, downloadVersion);
             startTask(`Refreshing the Docker image for "${runtime.envName}"...`);
             try {
-                await runCommand('source:download', AppUpgrade.buildDockerDownloadArgv(runtime, plan));
+                await runCommand('source:download', AppUpgrade.buildDockerDownloadArgv(runtime, plan, {
+                    verbose: flags.verbose,
+                }));
                 succeedTask(`Docker image is ready for "${runtime.envName}".`);
             }
             catch (error) {

package/dist/commands/backup/create.js

@@ -0,0 +1,147 @@
+/**
+ * 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 { BACKUP_CREATE_TIMEOUT_MS, BACKUP_POLL_INTERVAL_MS, BACKUP_RUNTIME_COMMANDS, buildBackupEnvArgv, ensureBackupRuntimeCommands, resolveBackupCreateOutputPath, resolveBackupTargetEnv, runBackupCliJsonCommand, sleep, } from '../../lib/backup.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { announceTargetEnv, failTask, startTask, succeedTask, updateTask } from '../../lib/ui.js';
+function formatBackupCreateTimeoutError(envName, name) {
+    return [
+        `Backup "${name}" did not finish in time for "${envName}".`,
+        `Waited ${Math.floor(BACKUP_CREATE_TIMEOUT_MS / 1000)}s but it still reports \`inProgress: true\`.`,
+    ].join(' ');
+}
+function readBackupCreateResult(response) {
+    const name = String(response.data?.name ?? '').trim();
+    if (!name) {
+        throw new Error('Backup creation did not return a backup name.');
+    }
+    return {
+        name,
+        inProgress: Boolean(response.data?.inProgress),
+    };
+}
+function readBackupInProgress(response, name) {
+    const status = response.data?.[name];
+    if (!status || typeof status !== 'object') {
+        throw new Error(`Backup status did not include "${name}".`);
+    }
+    return Boolean(status.inProgress);
+}
+function readDownloadOutput(response) {
+    const output = String(response.data?.output ?? '').trim();
+    return output || undefined;
+}
+export default class BackupCreate extends Command {
+    static summary = 'Create a backup through the selected env and download it locally';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --output ./fixtures/base.nbdump',
+        '<%= config.bin %> <%= command.id %> --env e2e --output ./fixtures',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to back up. Defaults to the current env when omitted',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: 'Download path. When omitted, save to the current directory using the remote backup filename',
+        }),
+        'json-output': Flags.boolean({
+            char: 'j',
+            description: 'Print the final backup result as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(BackupCreate);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const explicitEnvSelection = Boolean(requestedEnv && hasExplicitEnvSelection(this.argv));
+        const jsonOutput = Boolean(flags['json-output']);
+        if (explicitEnvSelection) {
+            const confirmed = await ensureCrossEnvConfirmed({
+                command: this,
+                requestedEnv,
+                yes: flags.yes,
+            });
+            if (!confirmed) {
+                return;
+            }
+        }
+        const { envName, env } = await resolveBackupTargetEnv(requestedEnv);
+        const envArgv = buildBackupEnvArgv({
+            requestedEnv,
+            explicitEnvSelection,
+            yes: flags.yes,
+        });
+        if (!jsonOutput) {
+            announceTargetEnv(envName);
+        }
+        await ensureBackupRuntimeCommands({
+            envName,
+            env,
+            commandIds: [
+                BACKUP_RUNTIME_COMMANDS.create,
+                BACKUP_RUNTIME_COMMANDS.status,
+                BACKUP_RUNTIME_COMMANDS.download,
+            ],
+            quiet: jsonOutput,
+        });
+        try {
+            if (!jsonOutput) {
+                startTask(`Creating backup for "${envName}"...`);
+            }
+            const createResponse = await runBackupCliJsonCommand(['api', 'backup', 'create', ...envArgv], { errorName: 'nb api backup create' });
+            const { name, inProgress } = readBackupCreateResult(createResponse);
+            const outputPath = await resolveBackupCreateOutputPath(flags.output, name);
+            const startedAt = Date.now();
+            let pending = inProgress;
+            while (pending) {
+                const now = Date.now();
+                const elapsedMs = now - startedAt;
+                if (elapsedMs >= BACKUP_CREATE_TIMEOUT_MS) {
+                    throw new Error(formatBackupCreateTimeoutError(envName, name));
+                }
+                const elapsedSeconds = Math.max(1, Math.floor(elapsedMs / 1000));
+                if (!jsonOutput) {
+                    updateTask(`Waiting for backup "${name}" to finish for "${envName}"... (${elapsedSeconds}s elapsed)`);
+                }
+                await sleep(BACKUP_POLL_INTERVAL_MS);
+                const statusResponse = await runBackupCliJsonCommand(['api', 'backup', 'status', '--name', name, ...envArgv], { errorName: 'nb api backup status' });
+                pending = readBackupInProgress(statusResponse, name);
+            }
+            if (!jsonOutput) {
+                updateTask(`Downloading backup "${name}" for "${envName}"...`);
+            }
+            const downloadResponse = await runBackupCliJsonCommand(['api', 'backup', 'download', '--name', name, '--output', outputPath, ...envArgv], { errorName: 'nb api backup download' });
+            const savedPath = readDownloadOutput(downloadResponse) ?? outputPath;
+            const result = {
+                env: envName,
+                name,
+                output: savedPath,
+            };
+            if (jsonOutput) {
+                this.log(JSON.stringify(result, null, 2));
+                return;
+            }
+            succeedTask(`Backup saved to ${savedPath}`);
+        }
+        catch (error) {
+            if (!jsonOutput) {
+                failTask(`Failed to create backup for "${envName}".`);
+            }
+            throw error;
+        }
+    }
+}

package/dist/commands/backup/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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, loadHelpClass } from '@oclif/core';
+export default class Backup extends Command {
+    static summary = 'Create or restore NocoBase backups';
+    async run() {
+        await this.parse(Backup);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'backup',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/backup/restore.js

@@ -0,0 +1,105 @@
+/**
+ * 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 { BACKUP_RUNTIME_COMMANDS, buildBackupEnvArgv, ensureBackupRuntimeCommands, resolveBackupRestoreFilePath, resolveBackupTargetEnv, resolveBackupWaitApiBaseUrl, runBackupCliCommand, } from '../../lib/backup.js';
+import { waitForAppReady } from '../../lib/app-health.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { confirm } from "../../lib/inquirer.js";
+import { announceTargetEnv, failTask, isInteractiveTerminal, startTask, stopTask, succeedTask } from '../../lib/ui.js';
+async function confirmBackupRestore(envName, filePath, force) {
+    if (force) {
+        return true;
+    }
+    if (!isInteractiveTerminal()) {
+        throw new Error(`\`nb backup restore\` needs confirmation. Re-run with \`--force\` to restore ${filePath} into "${envName}" in non-interactive mode.`);
+    }
+    try {
+        return await confirm({
+            message: `Restore backup "${filePath}" into "${envName}"? This will overwrite application data.`,
+            default: false,
+        });
+    }
+    catch {
+        return false;
+    }
+}
+export default class BackupRestore extends Command {
+    static summary = 'Restore a backup file into the selected env';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --file ./fixtures/base.nbdump --force',
+        '<%= config.bin %> <%= command.id %> --env e2e --file ./fixtures/base.nbdump --yes --force',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to restore into. Defaults to the current env when omitted',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        file: Flags.string({
+            char: 'f',
+            description: 'Local backup file to upload and restore',
+            required: true,
+        }),
+        force: Flags.boolean({
+            description: 'Confirm overwriting application data during restore',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(BackupRestore);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const explicitEnvSelection = Boolean(requestedEnv && hasExplicitEnvSelection(this.argv));
+        if (explicitEnvSelection) {
+            const confirmed = await ensureCrossEnvConfirmed({
+                command: this,
+                requestedEnv,
+                yes: flags.yes,
+            });
+            if (!confirmed) {
+                return;
+            }
+        }
+        const filePath = await resolveBackupRestoreFilePath(flags.file);
+        const { envName, env } = await resolveBackupTargetEnv(requestedEnv);
+        const restoreConfirmed = await confirmBackupRestore(envName, filePath, flags.force);
+        if (!restoreConfirmed) {
+            return;
+        }
+        const envArgv = buildBackupEnvArgv({
+            requestedEnv,
+            explicitEnvSelection,
+            yes: flags.yes,
+        });
+        announceTargetEnv(envName);
+        await ensureBackupRuntimeCommands({
+            envName,
+            env,
+            commandIds: [BACKUP_RUNTIME_COMMANDS.restoreUpload],
+        });
+        startTask(`Restoring backup for "${envName}" from ${filePath}...`);
+        try {
+            await runBackupCliCommand(['api', 'backup', 'restore-upload', '--file', filePath, '--force', ...envArgv], { errorName: 'nb api backup restore-upload' });
+            stopTask();
+            await waitForAppReady({
+                envName,
+                apiBaseUrl: resolveBackupWaitApiBaseUrl(env),
+            });
+            succeedTask(`Backup restored for "${envName}" from ${filePath}`);
+        }
+        catch (error) {
+            stopTask();
+            failTask(`Failed to restore backup for "${envName}".`);
+            throw error;
+        }
+    }
+}

package/dist/commands/config/delete.js

@@ -11,9 +11,13 @@ import { assertSupportedCliConfigKey, deleteCliConfigValue } from '../../lib/cli
 export default class ConfigDelete extends Command {
     static summary = 'Delete an explicitly configured CLI setting';
     static examples = [
+        '<%= config.bin %> <%= command.id %> locale',
         '<%= config.bin %> <%= command.id %> license.pkg-url',
         '<%= config.bin %> <%= command.id %> docker.network',
         '<%= config.bin %> <%= command.id %> docker.container-prefix',
+        '<%= config.bin %> <%= command.id %> bin.docker',
+        '<%= config.bin %> <%= command.id %> bin.git',
+        '<%= config.bin %> <%= command.id %> bin.yarn',
     ];
     static args = {
         key: Args.string({

package/dist/commands/config/get.js

@@ -11,9 +11,13 @@ import { assertSupportedCliConfigKey, getCliConfigValue } from '../../lib/cli-co
 export default class ConfigGet extends Command {
     static summary = 'Get the effective CLI configuration value for a key';
     static examples = [
+        '<%= config.bin %> <%= command.id %> locale',
         '<%= config.bin %> <%= command.id %> license.pkg-url',
         '<%= config.bin %> <%= command.id %> docker.network',
         '<%= config.bin %> <%= command.id %> docker.container-prefix',
+        '<%= config.bin %> <%= command.id %> bin.docker',
+        '<%= config.bin %> <%= command.id %> bin.git',
+        '<%= config.bin %> <%= command.id %> bin.yarn',
     ];
     static args = {
         key: Args.string({

package/dist/commands/config/set.js

@@ -10,11 +10,15 @@ import { Args, Command } from '@oclif/core';
 import { assertSupportedCliConfigKey, setCliConfigValue } from '../../lib/cli-config.js';
 export default class ConfigSet extends Command {
     static summary = 'Set a CLI configuration value';
-    static description = 'Set a supported CLI configuration key. Supported keys: license.pkg-url, docker.network, docker.container-prefix.';
+    static description = 'Set a supported CLI configuration key. Supported keys: locale, license.pkg-url, docker.network, docker.container-prefix, bin.docker, bin.git, bin.yarn.';
     static examples = [
+        '<%= config.bin %> <%= command.id %> locale zh-CN',
         '<%= config.bin %> <%= command.id %> license.pkg-url https://pkg.nocobase.com/',
         '<%= config.bin %> <%= command.id %> docker.network nocobase',
         '<%= config.bin %> <%= command.id %> docker.container-prefix nb',
+        '<%= config.bin %> <%= command.id %> bin.docker /usr/local/bin/docker',
+        '<%= config.bin %> <%= command.id %> bin.git /usr/bin/git',
+        '<%= config.bin %> <%= command.id %> bin.yarn yarn',
     ];
     static args = {
         key: Args.string({