@nocobase/cli 2.1.0-alpha.45 → 2.1.0-alpha.47

package/dist/commands/app/stop.js

@@ -6,10 +6,12 @@
  * 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 { fileURLToPath } from 'node:url';
 import { Command, Flags } from '@oclif/core';
 import { getCurrentEnvName } from '../../lib/auth-store.js';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
-import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { formatMissingManagedAppEnvMessage, managedAppLifecycleEnvVars, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { resolveProjectCwd, runNocoBaseCommand } from '../../lib/run-npm.js';
 import { announceTargetEnv, failTask, isInteractiveTerminal, printInfo, startTask, succeedTask } from '../../lib/ui.js';
 import { builtinDbContainerName, removeDockerContainerIfExists } from './shared.js';
 function formatStopFailure(envName, message) {
@@ -26,6 +28,33 @@ function formatStopCrossEnvConfirmationRequiredMessage(currentEnv, requestedEnv)
         'Re-run the command with `--yes` to confirm this one-off cross-env stop, or switch the current env first.',
     ].join('\n');
 }
+function isMissingManagedLocalProjectError(message) {
+    return (message.includes('The specified --cwd does not exist:') ||
+        message.includes('The specified --cwd is not a directory:') ||
+        message.includes("Couldn't find a NocoBase source project from --cwd:"));
+}
+async function stopLocalRuntimeWithFallback(runtime, options) {
+    const env = managedAppLifecycleEnvVars();
+    try {
+        await runLocalNocoBaseCommand(runtime, ['pm2', 'kill'], {
+            env,
+            stdio: options.stdio,
+        });
+        return;
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        if (!isMissingManagedLocalProjectError(message)) {
+            throw error;
+        }
+    }
+    const cliProjectCwd = resolveProjectCwd(fileURLToPath(new URL('.', import.meta.url)));
+    await runNocoBaseCommand(['pm2', 'kill'], {
+        cwd: cliProjectCwd,
+        env,
+        stdio: options.stdio,
+    });
+}
 export default class AppStop extends Command {
     static hidden = false;
     static description = 'Stop NocoBase for the selected env. Local npm/git installs stop the app process, and Docker installs remove the saved app container.';
@@ -121,7 +150,7 @@ export default class AppStop extends Command {
         else {
             startTask(`Stopping NocoBase for "${runtime.envName}"...`);
             try {
-                await runLocalNocoBaseCommand(runtime, ['pm2', 'kill'], {
+                await stopLocalRuntimeWithFallback(runtime, {
                     stdio: commandStdio,
                 });
                 succeedTask(`NocoBase has stopped for "${runtime.envName}".`);

package/dist/commands/app/upgrade.js

@@ -13,6 +13,7 @@ import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-
 import { DEFAULT_DOCKER_REGISTRY } from "../../lib/docker-image.js";
 import { confirm } from "../../lib/inquirer.js";
 import { announceTargetEnv, isInteractiveTerminal, printInfo, printWarning, succeedTask } from '../../lib/ui.js';
+import { resolveAppUrlFromApiBaseUrl } from '../env/shared.js';
 function trimValue(value) {
     return String(value ?? '').trim();
 }
@@ -25,15 +26,16 @@ function formatAppUrl(port) {
     return value ? `http://127.0.0.1:${value}` : undefined;
 }
 function formatDisplayUrl(apiBaseUrl, appPort) {
+    const resolvedFromApiBaseUrl = resolveAppUrlFromApiBaseUrl(apiBaseUrl);
+    if (resolvedFromApiBaseUrl) {
+        return resolvedFromApiBaseUrl;
+    }
     const appUrl = formatAppUrl(appPort);
     if (appUrl) {
         return appUrl;
     }
     const value = trimValue(apiBaseUrl);
-    if (!value) {
-        return undefined;
-    }
-    return value.replace(/\/api\/?$/, '');
+    return value ? value.replace(/\/api\/?$/, '') : undefined;
 }
 function readEnvValue(env, key) {
     return trimValue(env.config[key]);
@@ -312,7 +314,7 @@ export default class AppUpgrade extends Command {
             throw new Error([
                 `Env "${runtime.envName}" does not have a saved \`downloadVersion\`.`,
                 'This env cannot be upgraded until a source version is explicit.',
-                'Re-run `nb init` or `nb env add` for this env, or pass `--version` to `nb app upgrade`.',
+                `Re-run \`nb init --ui --env ${runtime.envName}\` for this env, or pass \`--version\` to \`nb app upgrade\`.`,
             ].join('\n'));
         }
         return {
@@ -383,7 +385,7 @@ export default class AppUpgrade extends Command {
             this.error([
                 `Can't upgrade "${runtime.envName}" from this machine.`,
                 'This env only has an API connection, so there is no saved local app or Docker runtime to upgrade here.',
-                'If you want a local NocoBase AI environment that the CLI can upgrade, run `nb init` first.',
+                'If you want a local NocoBase AI environment that the CLI can upgrade, run `nb init --ui` first.',
             ].join('\n'));
         }
         if (runtime.kind === 'ssh') {
@@ -493,8 +495,10 @@ export default class AppUpgrade extends Command {
                 });
             }
             await runWithSuppressedTargetEnvLog(async () => {
+                const startArgv = buildManagedActionArgv(runtime.envName, parsed, { quickstart: true });
+                startArgv.push('--no-sync-licensed-plugins');
                 await runWithSuppressedStartSuccessLog(async () => {
-                    await runCommand('app:start', buildManagedActionArgv(runtime.envName, parsed, { quickstart: true }));
+                    await runCommand('app:start', startArgv);
                 });
             });
             if (resolvedVersion.persistDownloadVersion) {

package/dist/commands/config/delete.js

@@ -8,16 +8,23 @@
  */
 import { Args, Command } from '@oclif/core';
 import { assertSupportedCliConfigKey, deleteCliConfigValue } from '../../lib/cli-config.js';
+import { clearLegacyStartupUpdatePolicyForCurrentInstall } from '../../lib/startup-update.js';
 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 %> update.policy',
         '<%= config.bin %> <%= command.id %> docker.network',
         '<%= config.bin %> <%= command.id %> docker.container-prefix',
         '<%= config.bin %> <%= command.id %> bin.docker',
+        '<%= config.bin %> <%= command.id %> bin.caddy',
         '<%= config.bin %> <%= command.id %> bin.git',
+        '<%= config.bin %> <%= command.id %> bin.nginx',
+        '<%= config.bin %> <%= command.id %> proxy.nb-cli-root',
+        '<%= config.bin %> <%= command.id %> proxy.upstream-host',
         '<%= config.bin %> <%= command.id %> bin.yarn',
+        '<%= config.bin %> <%= command.id %> log.enabled',
+        '<%= config.bin %> <%= command.id %> log.retention-days',
     ];
     static args = {
         key: Args.string({
@@ -29,6 +36,7 @@ export default class ConfigDelete extends Command {
         const { args } = await this.parse(ConfigDelete);
         const key = assertSupportedCliConfigKey(args.key);
         const removed = await deleteCliConfigValue(key);
-        this.log(removed ? `Deleted ${key}` : `${key} was not set`);
+        const clearedLegacy = key === 'update.policy' ? await clearLegacyStartupUpdatePolicyForCurrentInstall() : false;
+        this.log(removed || clearedLegacy ? `Deleted ${key}` : `${key} was not set`);
     }
 }

package/dist/commands/config/get.js

@@ -12,12 +12,18 @@ 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 %> update.policy',
         '<%= config.bin %> <%= command.id %> docker.network',
         '<%= config.bin %> <%= command.id %> docker.container-prefix',
         '<%= config.bin %> <%= command.id %> bin.docker',
+        '<%= config.bin %> <%= command.id %> bin.caddy',
         '<%= config.bin %> <%= command.id %> bin.git',
+        '<%= config.bin %> <%= command.id %> bin.nginx',
+        '<%= config.bin %> <%= command.id %> proxy.nb-cli-root',
+        '<%= config.bin %> <%= command.id %> proxy.upstream-host',
         '<%= config.bin %> <%= command.id %> bin.yarn',
+        '<%= config.bin %> <%= command.id %> log.enabled',
+        '<%= config.bin %> <%= command.id %> log.retention-days',
     ];
     static args = {
         key: Args.string({

package/dist/commands/config/set.js

@@ -8,17 +8,24 @@
  */
 import { Args, Command } from '@oclif/core';
 import { assertSupportedCliConfigKey, setCliConfigValue } from '../../lib/cli-config.js';
+import { clearLegacyStartupUpdatePolicyForCurrentInstall } from '../../lib/startup-update.js';
 export default class ConfigSet extends Command {
     static summary = 'Set a CLI configuration value';
-    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 description = 'Set a CLI configuration value for a supported configuration key.';
     static examples = [
         '<%= config.bin %> <%= command.id %> locale zh-CN',
-        '<%= config.bin %> <%= command.id %> license.pkg-url https://pkg.nocobase.com/',
+        '<%= config.bin %> <%= command.id %> update.policy prompt',
         '<%= 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.caddy /usr/bin/caddy',
         '<%= config.bin %> <%= command.id %> bin.git /usr/bin/git',
+        '<%= config.bin %> <%= command.id %> bin.nginx /usr/sbin/nginx',
+        '<%= config.bin %> <%= command.id %> proxy.nb-cli-root /workspace',
+        '<%= config.bin %> <%= command.id %> proxy.upstream-host host.docker.internal',
         '<%= config.bin %> <%= command.id %> bin.yarn yarn',
+        '<%= config.bin %> <%= command.id %> log.enabled false',
+        '<%= config.bin %> <%= command.id %> log.retention-days 14',
     ];
     static args = {
         key: Args.string({
@@ -34,6 +41,9 @@ export default class ConfigSet extends Command {
         const { args } = await this.parse(ConfigSet);
         const key = assertSupportedCliConfigKey(args.key);
         const value = await setCliConfigValue(key, args.value);
+        if (key === 'update.policy') {
+            await clearLegacyStartupUpdatePolicyForCurrentInstall();
+        }
         this.log(`${key}=${value}`);
     }
 }

package/dist/commands/db/ps.js

@@ -13,10 +13,7 @@ import { renderTable } from '../../lib/ui.js';
 import { builtinDbStatus, resolveDbRuntime } from './shared.js';
 export default class DbPs extends Command {
     static description = 'Show built-in database runtime status for configured envs without starting or stopping anything.';
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> --env app1',
-    ];
+    static examples = ['<%= config.bin %> <%= command.id %>', '<%= config.bin %> <%= command.id %> --env app1'];
     static flags = {
         env: Flags.string({
             char: 'e',
@@ -26,11 +23,9 @@ export default class DbPs extends Command {
     async run() {
         const { flags } = await this.parse(DbPs);
         const requestedEnv = flags.env?.trim() || undefined;
-        const envNames = requestedEnv
-            ? [requestedEnv]
-            : Object.keys((await listEnvs()).envs).sort();
+        const envNames = requestedEnv ? [requestedEnv] : Object.keys((await listEnvs()).envs).sort();
         if (!envNames.length) {
-            this.log('No NocoBase env is configured yet. Run `nb init` to create one first.');
+            this.log('No NocoBase env is configured yet. Run `nb init --ui` to create one first.');
             return;
         }
         const rows = [];
@@ -44,16 +39,8 @@ export default class DbPs extends Command {
                 continue;
             }
             const type = runtime.kind === 'builtin' ? 'builtin' : runtime.status;
-            const status = runtime.kind === 'builtin'
-                ? await builtinDbStatus(runtime.containerName)
-                : runtime.status;
-            rows.push([
-                runtime.envName,
-                type,
-                runtime.dbDialect,
-                status,
-                runtime.address,
-            ]);
+            const status = runtime.kind === 'builtin' ? await builtinDbStatus(runtime.containerName) : runtime.status;
+            rows.push([runtime.envName, type, runtime.dbDialect, status, runtime.address]);
         }
         this.log(renderTable(['Env', 'Type', 'Dialect', 'Status', 'Address'], rows));
     }

package/dist/commands/env/add.js

@@ -9,44 +9,12 @@
 import { Args, Command, Flags } from '@oclif/core';
 import { setCurrentEnv, upsertEnv } from '../../lib/auth-store.js';
 import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
-import { buildStoredEnvConfig, } from '../../lib/env-config.js';
+import { ENV_BOOLEAN_CONFIG_FLAG_MAP, ENV_STRING_CONFIG_FLAG_MAP } from '../../lib/env-command-config.js';
+import { buildStoredEnvConfig } from '../../lib/env-config.js';
 import { runPromptCatalog, } from '../../lib/prompt-catalog.js';
 import { applyCliLocale, CLI_LOCALE_FLAG_DESCRIPTION, CLI_LOCALE_FLAG_OPTIONS, localeText, } from '../../lib/cli-locale.js';
 import { validateApiBaseUrl } from '../../lib/prompt-validators.js';
 import { printInfo, printStage, printSuccess, printVerbose, setVerboseMode } from '../../lib/ui.js';
-const ENV_RUNTIME_FLAG_MAP = {
-    source: 'source',
-    'download-version': 'downloadVersion',
-    'docker-registry': 'dockerRegistry',
-    'docker-platform': 'dockerPlatform',
-    'git-url': 'gitUrl',
-    'npm-registry': 'npmRegistry',
-    'app-root-path': 'appRootPath',
-    'storage-path': 'storagePath',
-    'app-port': 'appPort',
-    'app-key': 'appKey',
-    timezone: 'timezone',
-    'db-dialect': 'dbDialect',
-    'builtin-db-image': 'builtinDbImage',
-    'db-host': 'dbHost',
-    'db-port': 'dbPort',
-    'db-database': 'dbDatabase',
-    'db-user': 'dbUser',
-    'db-password': 'dbPassword',
-    'db-schema': 'dbSchema',
-    'db-table-prefix': 'dbTablePrefix',
-    'root-username': 'rootUsername',
-    'root-email': 'rootEmail',
-    'root-password': 'rootPassword',
-    'root-nickname': 'rootNickname',
-};
-const ENV_BOOLEAN_RUNTIME_FLAG_MAP = {
-    'builtin-db': 'builtinDb',
-    'dev-dependencies': 'devDependencies',
-    build: 'build',
-    'build-dts': 'buildDts',
-    'db-underscored': 'dbUnderscored',
-};
 const envAddText = (key, values) => localeText(`commands.envAdd.${key}`, values);
 const envAddAccessTokenPrompt = {
     type: 'text',
@@ -182,14 +150,28 @@ export default class EnvAdd extends Command {
             hidden: true,
             description: 'Whether declaration files were emitted during build for this env',
         }),
+        'app-path': Flags.string({
+            hidden: true,
+            description: 'App path saved with this env',
+        }),
         'app-root-path': Flags.string({
             hidden: true,
+            deprecated: true,
             description: 'Application root path saved with this env',
         }),
         'storage-path': Flags.string({
             hidden: true,
+            deprecated: true,
             description: 'Storage path saved with this env',
         }),
+        'app-public-path': Flags.string({
+            hidden: true,
+            description: 'Application public path saved with this env',
+        }),
+        'env-file': Flags.string({
+            hidden: true,
+            description: 'Docker env file saved with this env',
+        }),
         'app-port': Flags.string({
             hidden: true,
             description: 'Application HTTP port saved with this env',
@@ -283,17 +265,17 @@ export default class EnvAdd extends Command {
             type: 'select',
             message: envAddText('prompts.authType.message'),
             options: [
-                {
-                    value: 'basic',
-                    label: envAddText('prompts.authType.basicLabel'),
-                    hint: envAddText('prompts.authType.basicHint'),
-                },
                 {
                     value: 'oauth',
                     label: envAddText('prompts.authType.oauthLabel'),
                     hint: envAddText('prompts.authType.oauthHint'),
                 },
                 { value: 'token', label: envAddText('prompts.authType.tokenLabel') },
+                {
+                    value: 'basic',
+                    label: envAddText('prompts.authType.basicLabel'),
+                    hint: envAddText('prompts.authType.basicHint'),
+                },
             ],
             initialValue: 'oauth',
             required: true,
@@ -360,20 +342,18 @@ export default class EnvAdd extends Command {
     }
     buildEnvConfig(results, flags) {
         const authType = String(results.authType ?? '').trim();
-        const authUsername = authType === 'basic'
-            ? String(results.username ?? flags.username ?? '').trim()
-            : '';
+        const authUsername = authType === 'basic' ? String(results.username ?? flags.username ?? '').trim() : '';
         const envConfigInput = {
             apiBaseUrl: results.apiBaseUrl,
             authType,
             authUsername: authUsername || undefined,
             accessToken: results.accessToken,
         };
-        for (const [flagName, configKey] of Object.entries(ENV_RUNTIME_FLAG_MAP)) {
+        for (const [flagName, configKey] of Object.entries(ENV_STRING_CONFIG_FLAG_MAP)) {
             const value = flags[flagName];
             envConfigInput[configKey] = value;
         }
-        for (const [flagName, configKey] of Object.entries(ENV_BOOLEAN_RUNTIME_FLAG_MAP)) {
+        for (const [flagName, configKey] of Object.entries(ENV_BOOLEAN_CONFIG_FLAG_MAP)) {
             const value = flags[flagName];
             envConfigInput[configKey] = value;
         }

package/dist/commands/env/auth.js

@@ -23,7 +23,7 @@ function resolveExplicitAuthType(value) {
     return value === 'basic' || value === 'token' || value === 'oauth' ? value : undefined;
 }
 function formatMissingEnvMessage(envName) {
-    return [`Env "${envName}" is not configured.`, `Run \`nb env add ${envName} --api-base-url <url>\` first.`].join('\n');
+    return [`Env "${envName}" is not configured.`, `Run \`nb init --ui --env ${envName}\` first.`].join('\n');
 }
 export default class EnvAuth extends Command {
     static summary = 'Authenticate a saved NocoBase environment with basic login, a token, or OAuth';

package/dist/commands/env/info.js

@@ -10,7 +10,7 @@ import { Args, Command, Flags } from '@oclif/core';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime } from '../../lib/app-runtime.js';
 import { resolveBuiltinDbConnection } from '../../lib/builtin-db.js';
 import { renderTable } from '../../lib/ui.js';
-import { appRootPath, appUrl, dbStatus, runtimeStatus, storagePath } from './shared.js';
+import { appPath, appUrl, dbStatus, runtimeStatus, sourcePath, storagePath } from './shared.js';
 const MISSING_FIELD = Symbol('missingField');
 const FORBIDDEN_FIELD_PATH_SEGMENTS = new Set(['__proto__', 'constructor', 'prototype']);
 function normalizeJsonValue(value) {
@@ -120,7 +120,8 @@ export default class EnvInfo extends Command {
         const dbDialect = builtinDbConnection?.dbDialect ?? runtime.env.config.dbDialect;
         const appGroup = {
             url: appUrl(runtime),
-            appRootPath: appRootPath(runtime),
+            appPath: appPath(runtime),
+            sourcePath: sourcePath(runtime),
             storagePath: storagePath(runtime),
             appPort: runtime.env.config.appPort,
             appStatus: await runtimeStatus(runtime),

package/dist/commands/env/list.js

@@ -9,13 +9,12 @@
 import { Command } from '@oclif/core';
 import { getCurrentEnvName, listEnvs, resolveConfiguredAuthType } from '../../lib/auth-store.js';
 import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
 import { renderTable } from '../../lib/ui.js';
 import { resolveApiBaseUrl } from './shared.js';
 export default class EnvList extends Command {
     static summary = 'List configured environments';
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-    ];
+    static examples = ['<%= config.bin %> <%= command.id %>'];
     async run() {
         await this.parse(EnvList);
         const scope = resolveDefaultConfigScope();
@@ -23,8 +22,8 @@ export default class EnvList extends Command {
         const currentEnv = await getCurrentEnvName({ scope });
         const names = Object.keys(envs).sort();
         if (!names.length) {
-            this.log('No envs configured.');
-            this.log('Run `nb env add <name> --api-base-url <url>` to add one.');
+            this.log(translateCli('commands.env.messages.noEnvsConfigured'));
+            this.log(translateCli('commands.env.messages.noEnvsConfiguredHelp'));
             return;
         }
         const rows = [];

package/dist/commands/env/proxy/caddy.js

@@ -0,0 +1,28 @@
+/**
+ * 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 } from '@oclif/core';
+import { createEnvProxyCaddyFlags, ENV_PROXY_NAME_ARG, runEnvProxyCommand } from './index.js';
+export default class EnvProxyCaddy extends Command {
+    static summary = 'Generate Caddy proxy files for one managed env';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --host a.local.nocobase.com --port 8080',
+        '<%= config.bin %> <%= command.id %> --env app1 --install --reload',
+        '<%= config.bin %> <%= command.id %> --env app1 --print',
+    ];
+    static args = {
+        name: ENV_PROXY_NAME_ARG,
+    };
+    static flags = createEnvProxyCaddyFlags();
+    async run() {
+        const { args, flags } = await this.parse(EnvProxyCaddy);
+        await runEnvProxyCommand(this, args, flags, 'caddy');
+    }
+}