@nocobase/cli 2.1.0-alpha.37 → 2.1.0-alpha.39

package/bin/run.js

@@ -5,7 +5,7 @@ import fs from 'node:fs';
 import { createRequire } from 'node:module';
 import path from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'node:url';
-import { normalizeSessionEnv } from './session-env.js';
+import { normalizeNodeOptions, normalizeSessionEnv } from './session-env.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const requireFromCli = createRequire(import.meta.url);
@@ -18,6 +18,7 @@ if (process.env.NB_CLI_USE_DIST === '1') {
 }
 
 normalizeSessionEnv();
+normalizeNodeOptions();
 
 /**
  * In the monorepo, plain `node` cannot load `.ts`. Re-exec once with `--import <tsx>`

package/bin/session-env.js

@@ -4,6 +4,7 @@ const SESSION_ENV_SOURCES = [
   'COPILOT_AGENT_SESSION_ID',
   'CLAUDE_CODE_SESSION_ID',
 ];
+const PRESERVE_SYMLINKS_FLAG = '--preserve-symlinks';
 
 export function resolveNormalizedSessionId(env = process.env) {
   for (const key of SESSION_ENV_SOURCES) {
@@ -25,3 +26,14 @@ export function normalizeSessionEnv(env = process.env) {
   env.NB_SESSION_ID = sessionId;
   return sessionId;
 }
+
+export function normalizeNodeOptions(env = process.env) {
+  const currentNodeOptions = String(env.NODE_OPTIONS ?? '').trim();
+  const flags = currentNodeOptions ? currentNodeOptions.split(/\s+/) : [];
+
+  if (!flags.includes(PRESERVE_SYMLINKS_FLAG)) {
+    env.NODE_OPTIONS = [...flags, PRESERVE_SYMLINKS_FLAG].join(' ');
+  }
+
+  return env.NODE_OPTIONS;
+}

package/dist/commands/app/restart.js

@@ -8,6 +8,11 @@
  */
 import { Command, Flags } from '@oclif/core';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, stopDockerContainer, } from '../../lib/app-runtime.js';
+import { formatAppUrl, resolveManagedAppApiBaseUrl, waitForAppReady } from '../../lib/app-health.js';
+import { recreateSavedDockerApp } from '../../lib/app-managed-resources.js';
+import { run } from '../../lib/run-npm.js';
+import { announceTargetEnv, failTask, startTask, succeedTask } from '../../lib/ui.js';
 function argvHasToken(argv, tokens) {
     return tokens.some((token) => argv.includes(token));
 }
@@ -16,9 +21,17 @@ function pushFlag(argv, flag, value) {
         argv.push(flag, String(value));
     }
 }
+function formatDockerRestartFailure(envName, message) {
+    return [
+        `Couldn't restart NocoBase for "${envName}".`,
+        'The CLI was not able to recreate the saved Docker app container successfully.',
+        'Check the saved Docker image, envFile, container settings, and database connection, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
 export default class AppRestart extends Command {
     static hidden = false;
-    static description = 'Restart NocoBase for the selected env by stopping it first, then starting it again.';
+    static description = 'Restart NocoBase for the selected env. Local npm/git installs stop and start the app again, and Docker installs recreate the saved app container so saved env changes can take effect.';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
         '<%= config.bin %> <%= command.id %> --env local',
@@ -71,6 +84,55 @@ export default class AppRestart extends Command {
                 return;
             }
         }
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        const commandStdio = flags.verbose ? 'inherit' : 'ignore';
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'docker') {
+            announceTargetEnv(runtime.envName);
+            startTask(`Stopping NocoBase for "${runtime.envName}" before restart...`);
+            try {
+                const state = await stopDockerContainer(runtime.containerName, {
+                    stdio: commandStdio,
+                });
+                succeedTask(state === 'already-stopped'
+                    ? `NocoBase was already stopped for "${runtime.envName}".`
+                    : `Stopped NocoBase for "${runtime.envName}".`);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                failTask(`Failed to stop NocoBase for "${runtime.envName}".`);
+                this.error(formatDockerRestartFailure(runtime.envName, message));
+            }
+            startTask(`Recreating the Docker app container for "${runtime.envName}"...`);
+            try {
+                await run('docker', ['rm', '-f', runtime.containerName], {
+                    errorName: 'docker rm',
+                    stdio: commandStdio,
+                }).catch(() => undefined);
+                await recreateSavedDockerApp(runtime, {
+                    verbose: flags.verbose,
+                });
+                succeedTask(`Docker app container is ready for "${runtime.envName}".`);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                failTask(`Failed to recreate NocoBase for "${runtime.envName}".`);
+                this.error(formatDockerRestartFailure(runtime.envName, message));
+            }
+            const appUrl = formatAppUrl(runtime.env.appPort === undefined || runtime.env.appPort === null
+                ? undefined
+                : String(runtime.env.appPort));
+            await waitForAppReady({
+                envName: runtime.envName,
+                apiBaseUrl: resolveManagedAppApiBaseUrl(runtime),
+                containerName: runtime.containerName,
+                logHint: `You can inspect startup logs with \`nb app logs --env ${runtime.envName}\`.`,
+            });
+            succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+            return;
+        }
         const stopArgv = [];
         const daemonFlagWasProvided = argvHasToken(this.argv, ['--daemon', '--no-daemon']);
         pushFlag(stopArgv, '--env', requestedEnv);

package/dist/commands/app/start.js

@@ -10,7 +10,8 @@ import { Command, Flags } from '@oclif/core';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, startDockerContainer, } from '../../lib/app-runtime.js';
 import { AppHealthCheckError, formatAppUrl, isAppReady, resolveManagedAppApiBaseUrl, waitForAppReady, } from '../../lib/app-health.js';
-import { ensureBuiltinDbReady, ensureSavedLocalSource, recreateSavedDockerApp, } from '../../lib/app-managed-resources.js';
+import { ensureBuiltinDbReady, ensureLocalPostinstall, ensureSavedLocalSource, recreateSavedDockerApp, } from '../../lib/app-managed-resources.js';
+import { run } from '../../lib/run-npm.js';
 import { announceTargetEnv, failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
 function argvHasToken(argv, tokens) {
     return tokens.some((token) => argv.includes(token));
@@ -89,6 +90,10 @@ export default class AppStart extends Command {
             description: 'Show raw startup output from the underlying local or Docker command',
             default: false,
         }),
+        recreate: Flags.boolean({
+            description: 'Recreate the saved Docker app container before starting it',
+            default: false,
+        }),
     };
     async run() {
         const { flags } = await this.parse(AppStart);
@@ -149,29 +154,49 @@ export default class AppStart extends Command {
                 ? undefined
                 : String(runtime.env.appPort));
             const apiBaseUrl = resolveManagedAppApiBaseUrl(runtime);
-            startTask(`Starting NocoBase for "${runtime.envName}"...`);
-            try {
-                const state = await startDockerContainer(runtime.containerName, {
-                    stdio: commandStdio,
-                });
-                if (state === 'already-running' && await isAppReady(apiBaseUrl)) {
-                    succeedTask(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
-                    return;
-                }
-            }
-            catch (error) {
-                const message = error instanceof Error ? error.message : String(error);
-                if (/does not exist/i.test(message)) {
-                    printInfo(`The saved Docker app container for "${runtime.envName}" is missing. Recreating it from the saved Docker env settings...`);
+            if (flags.recreate) {
+                startTask(`Recreating the Docker app container for "${runtime.envName}"...`);
+                try {
+                    await run('docker', ['rm', '-f', runtime.containerName], {
+                        errorName: 'docker rm',
+                        stdio: commandStdio,
+                    }).catch(() => undefined);
                     await recreateSavedDockerApp(runtime, {
                         verbose: flags.verbose,
                     });
+                    succeedTask(`Docker app container is ready for "${runtime.envName}".`);
                 }
-                else {
-                    failTask(`Failed to start NocoBase for "${runtime.envName}".`);
+                catch (error) {
+                    const message = error instanceof Error ? error.message : String(error);
+                    failTask(`Failed to recreate NocoBase for "${runtime.envName}".`);
                     this.error(formatDockerStartFailure(runtime.envName, message));
                 }
             }
+            else {
+                startTask(`Starting NocoBase for "${runtime.envName}"...`);
+                try {
+                    const state = await startDockerContainer(runtime.containerName, {
+                        stdio: commandStdio,
+                    });
+                    if (state === 'already-running' && await isAppReady(apiBaseUrl)) {
+                        succeedTask(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+                        return;
+                    }
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : String(error);
+                    if (/does not exist/i.test(message)) {
+                        printInfo(`The saved Docker app container for "${runtime.envName}" is missing. Recreating it from the saved Docker env settings...`);
+                        await recreateSavedDockerApp(runtime, {
+                            verbose: flags.verbose,
+                        });
+                    }
+                    else {
+                        failTask(`Failed to start NocoBase for "${runtime.envName}".`);
+                        this.error(formatDockerStartFailure(runtime.envName, message));
+                    }
+                }
+            }
             await waitForAppReady({
                 envName: runtime.envName,
                 apiBaseUrl,
@@ -233,6 +258,17 @@ export default class AppStart extends Command {
             }
             return;
         }
+        try {
+            await ensureLocalPostinstall(runtime, {
+                verbose: flags.verbose,
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+            });
+        }
+        catch (error) {
+            this.error(error instanceof Error ? error.message : String(error));
+        }
         if (flags.daemon === false) {
             printInfo(`Starting NocoBase for "${runtime.envName}" in the foreground${appUrl ? ` at ${appUrl}` : ''}. Press Ctrl+C to stop.`);
         }

package/dist/commands/app/upgrade.js

@@ -8,9 +8,11 @@
  */
 import { Command, Flags } from '@oclif/core';
 import { upsertEnv } from '../../lib/auth-store.js';
+import { ensureLocalPostinstall } from '../../lib/app-managed-resources.js';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, startDockerContainer, stopDockerContainer, } from '../../lib/app-runtime.js';
 import { resolveConfiguredEnvPath } from '../../lib/cli-home.js';
 import { deriveBuiltinDbConnection } from '../../lib/builtin-db.js';
+import { resolveDockerEnvFileArg } from "../../lib/docker-env-file.js";
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
 import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageRef, } from "../../lib/docker-image.js";
 import { commandSucceeds, run } from '../../lib/run-npm.js';
@@ -311,12 +313,13 @@ export default class AppUpgrade extends Command {
         argv.push('--daemon');
         return argv;
     }
-    static buildDockerUpgradePlan(runtime, downloadVersion) {
+    static async buildDockerUpgradePlan(runtime, downloadVersion) {
         const dockerRegistry = readEnvValue(runtime.env, 'dockerRegistry') || DEFAULT_DOCKER_REGISTRY;
         const appPort = runtime.env.appPort === undefined || runtime.env.appPort === null
             ? ''
             : trimValue(runtime.env.appPort);
         const storagePath = readEnvValue(runtime.env, 'storagePath');
+        const envFile = await resolveDockerEnvFileArg(runtime.envName, runtime.env.config);
         const appKey = readEnvValue(runtime.env, 'appKey');
         const timeZone = readEnvValue(runtime.env, 'timezone');
         const builtinDbConnection = runtime.env.config.builtinDb ? deriveBuiltinDbConnection(runtime) : undefined;
@@ -378,6 +381,9 @@ export default class AppUpgrade extends Command {
         if (appPort) {
             args.push('-p', `${appPort}:80`);
         }
+        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);
         return {
             containerName: runtime.containerName,
@@ -387,6 +393,7 @@ export default class AppUpgrade extends Command {
             imageRef,
             appPort: appPort || undefined,
             storagePath,
+            envFile,
             appKey,
             timeZone,
             dbDialect,
@@ -430,6 +437,12 @@ export default class AppUpgrade extends Command {
         else {
             printInfo(`Skipping code download for "${runtime.envName}" because this env is managed from an existing local app path.`);
         }
+        await ensureLocalPostinstall(runtime, {
+            verbose: flags.verbose,
+            onStartTask: startTask,
+            onSucceedTask: succeedTask,
+            onFailTask: failTask,
+        });
         startTask(`Starting upgraded NocoBase for "${runtime.envName}"...`);
         try {
             await runLocalNocoBaseCommand(runtime, AppUpgrade.buildLocalStartArgv(runtime), {
@@ -452,7 +465,7 @@ export default class AppUpgrade extends Command {
         const apiBaseUrl = resolveApiBaseUrl(runtime);
         const containerExists = await dockerContainerExists(runtime.containerName);
         if (!flags['skip-code-update']) {
-            const plan = AppUpgrade.buildDockerUpgradePlan(runtime, downloadVersion);
+            const plan = await AppUpgrade.buildDockerUpgradePlan(runtime, downloadVersion);
             startTask(`Refreshing the Docker image for "${runtime.envName}"...`);
             try {
                 await runCommand('source:download', AppUpgrade.buildDockerDownloadArgv(runtime, plan));
@@ -500,7 +513,7 @@ export default class AppUpgrade extends Command {
             }
         }
         else {
-            const plan = AppUpgrade.buildDockerUpgradePlan(runtime, downloadVersion);
+            const plan = await AppUpgrade.buildDockerUpgradePlan(runtime, downloadVersion);
             const displayUrl = formatDisplayUrl(apiBaseUrl, plan.appPort);
             startTask(`Recreating the Docker app container for "${runtime.envName}"...`);
             try {

package/dist/commands/install.js

@@ -26,6 +26,7 @@ import { printInfo, printStage, printVerbose, printWarning, setVerboseMode, } fr
 import { omitKeys, upperFirst } from "../lib/object-utils.js";
 import { getEnv, setCurrentEnv, upsertEnv } from '../lib/auth-store.js';
 import { buildStoredEnvConfig } from '../lib/env-config.js';
+import { resolveDockerEnvFileArg, } from "../lib/docker-env-file.js";
 import Download, { defaultDockerRegistryForLang, } from './download.js';
 import EnvAdd from "./env/add.js";
 const DEFAULT_INSTALL_ENV_NAME = 'local';
@@ -1575,7 +1576,7 @@ export default class Install extends Command {
         printVerbose(`Built-in ${plan.dbDialect} database ready at ${plan.dbHost}:${plan.dbPort}`);
         return plan;
     }
-    static buildDockerAppPlan(params) {
+    static async buildDockerAppPlan(params) {
         const dockerRegistry = String(downloadResultsValue(params.downloadResults, 'dockerRegistry') ?? '').trim()
             || defaultDockerRegistryForLang(process.env.NB_LOCALE);
         const version = String(downloadResultsValue(params.downloadResults, 'version') ?? '').trim() || DEFAULT_DOCKER_VERSION;
@@ -1598,6 +1599,8 @@ export default class Install extends Command {
         const appKey = crypto.randomBytes(32).toString('hex');
         const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone || 'UTC';
         const containerName = Install.buildDockerAppContainerName(params.envName, params.dockerContainerPrefix ?? params.workspaceName);
+        const configuredEnvFile = String(params.appResults.envFile ?? '').trim();
+        const envFile = await resolveDockerEnvFileArg(params.envName, configuredEnvFile ? { envFile: configuredEnvFile } : undefined);
         const initEnvVars = Install.buildInitAppEnvVars({
             appResults: params.appResults,
             rootResults: params.rootResults,
@@ -1614,6 +1617,9 @@ export default class Install extends Command {
             '-p',
             `${appPort}:80`,
         ];
+        if (envFile) {
+            args.push('--env-file', envFile);
+        }
         for (const [key, value] of Object.entries(initEnvVars)) {
             args.push('-e', `${key}=${value}`);
         }
@@ -1625,6 +1631,7 @@ export default class Install extends Command {
             imageRef,
             appPort,
             storagePath,
+            envFile,
             appKey,
             timeZone,
             args,
@@ -1647,7 +1654,7 @@ export default class Install extends Command {
         const networkName = params.builtinDbPlan?.networkName
             ?? Install.buildBuiltinDbNetworkName(params.envName, params.dockerNetworkName ?? params.workspaceName);
         await this.ensureDockerNetwork(networkName);
-        const plan = Install.buildDockerAppPlan({
+        const plan = await Install.buildDockerAppPlan({
             envName: params.envName,
             workspaceName: params.workspaceName,
             dockerContainerPrefix: params.dockerContainerPrefix,
@@ -1941,6 +1948,7 @@ export default class Install extends Command {
             || DEFAULT_INSTALL_APP_PORT;
         const storagePath = String(params.appResults.storagePath ?? '').trim()
             || defaultInstallStoragePath(params.envName);
+        const envFile = String(params.appResults.envFile ?? '').trim() || undefined;
         const apiBaseUrl = Install.resolveApiBaseUrl({
             appResults: params.appResults,
             envAddResults: params.envAddResults,
@@ -1963,6 +1971,7 @@ export default class Install extends Command {
             appRootPath: params.appResults.appRootPath,
             appPort,
             storagePath,
+            ...(envFile ? { envFile } : {}),
             appKey: params.appResults.appKey,
             timezone: params.appResults.timeZone,
             builtinDb: params.dbResults.builtinDb,

package/dist/commands/source/dev.js

@@ -8,8 +8,9 @@
  */
 import { Command, Flags } from '@oclif/core';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { ensureLocalPostinstall } from '../../lib/app-managed-resources.js';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
-import { announceTargetEnv, printInfo } from '../../lib/ui.js';
+import { announceTargetEnv, failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
 function formatUnsupportedRuntimeMessage(kind, envName) {
     if (kind === 'docker') {
         return [
@@ -159,6 +160,12 @@ export default class SourceDev extends Command {
         }
         printInfo(`Starting NocoBase dev mode for "${runtime.envName}" from ${runtime.projectRoot}. Press Ctrl+C to stop.`);
         try {
+            await ensureLocalPostinstall(runtime, {
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+                verbose: true,
+            });
             await runLocalNocoBaseCommand(runtime, npmArgs, {
                 stdio: 'inherit',
             });

package/dist/commands/source/publish.js

@@ -0,0 +1,92 @@
+/**
+ * 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 { buildSuggestedInitCommand, publishSourceSnapshot } from '../../lib/source-publish.js';
+import { failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+function formatPublishFailure(message) {
+    return [
+        'Couldn\'t publish a source snapshot.',
+        'Check that Docker is running, the target npm registry is reachable, and the current directory is a NocoBase source repo.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourcePublish extends Command {
+    static description = 'Publish the current NocoBase source repo as a snapshot version to an npm registry for install testing.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --snapshot',
+        '<%= config.bin %> <%= command.id %> --snapshot --cwd /path/to/nocobase/source',
+        '<%= config.bin %> <%= command.id %> --snapshot --npm-registry=http://127.0.0.1:4873',
+        '<%= config.bin %> <%= command.id %> --snapshot --json',
+    ];
+    static flags = {
+        snapshot: Flags.boolean({
+            description: 'Publish the current source repo as a unique snapshot version',
+            required: true,
+            default: false,
+        }),
+        'npm-registry': Flags.string({
+            description: 'npm registry URL to publish to. Defaults to the running local source registry when available',
+            required: false,
+        }),
+        cwd: Flags.string({
+            description: 'Source repository path. Defaults to the nearest detected NocoBase source root from the current working directory',
+            required: false,
+        }),
+        json: Flags.boolean({
+            description: 'Print the publish result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed command output while versioning and publishing the snapshot',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourcePublish);
+        if (!flags.snapshot) {
+            this.error('`nb source publish` currently requires `--snapshot`.');
+        }
+        if (!flags.json) {
+            startTask('Publishing a source snapshot...');
+        }
+        try {
+            const result = await publishSourceSnapshot({
+                cwd: flags.cwd,
+                npmRegistry: flags['npm-registry'],
+                verbose: flags.verbose,
+            });
+            if (flags.json) {
+                this.log(JSON.stringify({
+                    version: result.version,
+                    npmRegistry: result.npmRegistry,
+                    gitSha: result.gitSha,
+                    projectRoot: result.projectRoot,
+                    suggestedInitCommand: buildSuggestedInitCommand(result),
+                }, null, 2));
+                return;
+            }
+            succeedTask(`Published source snapshot ${result.version} to ${result.npmRegistry}.`);
+            printInfo(`Source root: ${result.projectRoot}`);
+            printInfo(`Snapshot version: ${result.version}`);
+            printInfo(`npm registry: ${result.npmRegistry}`);
+            printInfo(`Next: ${buildSuggestedInitCommand(result)}`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            if (flags.json) {
+                this.logToStderr(JSON.stringify({
+                    error: formatPublishFailure(message),
+                }, null, 2));
+                this.exit(1);
+            }
+            failTask('Failed to publish the source snapshot.');
+            this.error(formatPublishFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/logs.js

@@ -0,0 +1,70 @@
+/**
+ * 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 { run } from '../../../lib/run-npm.js';
+import { printInfo } from '../../../lib/ui.js';
+import { getSourceRegistryInfo } from '../../../lib/source-registry.js';
+function formatLogsFailure(message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            'Can\'t show source registry logs yet.',
+            'The saved source registry container could not be found on this machine.',
+            'Start the registry first with `nb source registry start`.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        'Couldn\'t show source registry logs.',
+        'Check that Docker is installed and the source registry container still exists, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourceRegistryLogs extends Command {
+    static description = 'Show logs for the local Docker-based npm registry used for source tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --tail 200',
+        '<%= config.bin %> <%= command.id %> --follow',
+    ];
+    static flags = {
+        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: false,
+            allowNo: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryLogs);
+        const info = getSourceRegistryInfo();
+        printInfo(flags.follow
+            ? `Showing source registry logs from "${info.containerName}" (press Ctrl+C to stop).`
+            : `Showing recent source registry logs from "${info.containerName}".`);
+        const dockerArgs = ['logs', '--tail', String(flags.tail ?? 100)];
+        if (flags.follow) {
+            dockerArgs.push('--follow');
+        }
+        dockerArgs.push(info.containerName);
+        try {
+            await run('docker', dockerArgs, {
+                errorName: 'docker logs',
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(formatLogsFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/start.js

@@ -0,0 +1,57 @@
+/**
+ * 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 { failTask, startTask, succeedTask } from '../../../lib/ui.js';
+import { getSourceRegistryInfo, startSourceRegistry } from '../../../lib/source-registry.js';
+function formatStartFailure(message) {
+    if (/port is already allocated|address already in use/i.test(message)) {
+        return [
+            'Can\'t start the source registry.',
+            'Port 4873 is already in use on this machine.',
+            'Stop the conflicting process, or free the port before trying again.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        'Couldn\'t start the source registry.',
+        'Check that Docker is installed and running, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class SourceRegistryStart extends Command {
+    static description = 'Start the local Docker-based npm registry used for source snapshot publish and install tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --verbose',
+    ];
+    static flags = {
+        verbose: Flags.boolean({
+            description: 'Show raw Docker output while starting the registry container',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryStart);
+        const info = getSourceRegistryInfo();
+        startTask(`Starting the source registry at ${info.url}...`);
+        try {
+            const state = await startSourceRegistry({
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+            succeedTask(state === 'already-running'
+                ? `The source registry is already running at ${info.url}.`
+                : `The source registry is running at ${info.url}.`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask('Failed to start the source registry.');
+            this.error(formatStartFailure(message));
+        }
+    }
+}

package/dist/commands/source/registry/status.js

@@ -0,0 +1,33 @@
+/**
+ * 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 { renderTable } from '../../../lib/ui.js';
+import { resolveSourceRegistryInfo } from '../../../lib/source-registry.js';
+export default class SourceRegistryStatus extends Command {
+    static description = 'Show the status of the local Docker-based npm registry used for source tests.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        json: Flags.boolean({
+            description: 'Print the source registry status as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SourceRegistryStatus);
+        const info = await resolveSourceRegistryInfo();
+        if (flags.json) {
+            this.log(JSON.stringify(info, null, 2));
+            return;
+        }
+        this.log(renderTable(['Container', 'Status', 'URL', 'Storage'], [[info.containerName, info.status, info.url, info.storageDir]]));
+    }
+}