@nocobase/cli 2.2.0-alpha.1 → 2.2.0-alpha.10

package/dist/commands/init.js

@@ -15,22 +15,29 @@ import { stdin as stdinStream, stdout as stdoutStream } from 'node:process';
 import { getEnv, upsertEnv } from "../lib/auth-store.js";
 import { runPromptCatalog, } from "../lib/prompt-catalog.js";
 import { applyCliLocale, localeText, translateCli } from "../lib/cli-locale.js";
-import { resolveDefaultConfigScope } from '../lib/cli-home.js';
-import { resolveDefaultApiHost, resolveDefaultUiHost } from '../lib/cli-config.js';
+import { resolveConfiguredEnvPath, resolveDefaultConfigScope, resolveEnvRelativePath } from '../lib/cli-home.js';
+import { getCliConfigValue, resolveDefaultApiHost, resolveDefaultUiHost } from '../lib/cli-config.js';
+import { resolveOfficialDockerRegistry } from '../lib/docker-image.js';
 import { areConfiguredPathsEquivalent, deriveConfiguredSourcePath, deriveConfiguredStoragePath, inferConfiguredAppPathFromLegacyConfig, } from '../lib/env-paths.js';
 import { formatMissingManagedAppEnvMessage } from '../lib/app-runtime.js';
 import { runPromptCatalogWebUI } from "../lib/prompt-web-ui.js";
 import { validateApiBaseUrl, validateEnvKey } from "../lib/prompt-validators.js";
 import { installNocoBaseSkills, isNpmRegistryUnavailable } from '../lib/skills-manager.js';
 import { omitKeys, pickKeys } from "../lib/object-utils.js";
+import { ENV_CONFIG_SCHEMA_VERSION } from '../lib/env-config.js';
 import { printInfo, printStage, printVerbose, printWarning } from '../lib/ui.js';
+import { persistHookScript } from '../lib/hook-script.js';
 import Download from "./download.js";
 import EnvAdd from "./env/add.js";
 import Install, { defaultDbPortForDialect } from "./install.js";
 const DEFAULT_INIT_API_BASE_URL = 'http://localhost:13000/api';
 const DEFAULT_INIT_APP_NAME = 'local';
+const DEFAULT_INIT_PORTAL_TYPE = 'no-code';
+const DEFAULT_INIT_PORTAL_NAME = 'admin';
+const DEFAULT_INIT_PORTAL_TEMPLATE = '@nocobase/portal-template-default';
 const DOWNLOAD_OUTPUT_DIR_PROMPT = Download.prompts.outputDir;
 const INIT_SETUP_MODES = ['install-new', 'manage-local', 'connect-remote'];
+const INIT_PORTAL_TYPES = ['no-code', 'ai'];
 const INIT_ENV_ADD_FLAG_NAMES = [
     'locale',
     'default-api-base-url',
@@ -77,6 +84,9 @@ function isInstallNewSetupMode(values) {
 function isInstallLikeSetupMode(values) {
     return !isRemoteSetupMode(values);
 }
+function isAiMode(values) {
+    return String(values.portalType ?? DEFAULT_INIT_PORTAL_TYPE).trim() === 'ai';
+}
 function remoteConnectionOnly(def) {
     return withExtraHidden(def, (values) => !isRemoteSetupMode(values));
 }
@@ -246,16 +256,12 @@ function formatBrowserOpenError(error) {
     return String(error);
 }
 export default class Init extends Command {
-    static summary = 'Set up NocoBase so coding agents can connect and work with it';
-    static description = `Set up NocoBase for coding agents in the current workspace.
-
-\`nb init\` prepares a NocoBase environment that coding agents can use. It supports three setup paths:
+    static summary = 'Set up or connect a NocoBase environment in the current workspace';
+    static description = `Set up NocoBase in the current workspace.
 
-- Install a new NocoBase app, then save it as a CLI env.
-- Take over managing an app that already exists on this machine by reusing its database.
-- Connect a remote NocoBase app and save it as a CLI env.
+\`nb init\` helps you install a new NocoBase app, take over managing one that already exists on this machine, or connect a remote NocoBase app and save it as a CLI env.
 
-It can also install NocoBase AI coding skills (\`nocobase/skills\`) so agents get the project-specific workflow guidance.
+You can use the saved environment directly, or let a coding agent access it later. It can also install NocoBase AI coding skills (\`nocobase/skills\`) when you want agent-specific workflow guidance.
 
 If setup was interrupted earlier, use \`--resume\` with an existing env name to continue from the saved workspace config.
 
@@ -388,6 +394,42 @@ Prompt modes:
         devDependencies: installLikeDownloadExecutionOnly(Download.prompts.devDependencies),
         build: installLikeDownloadExecutionOnly(Download.prompts.build),
         buildDts: installLikeDownloadExecutionOnly(Download.prompts.buildDts),
+        portalType: installNewOnly({
+            type: 'select',
+            variant: 'radio',
+            message: initText('prompts.portalType.message'),
+            options: [
+                {
+                    value: 'no-code',
+                    label: initText('prompts.portalType.noCodeLabel'),
+                    hint: initText('prompts.portalType.noCodeHint'),
+                },
+                {
+                    value: 'ai',
+                    label: initText('prompts.portalType.aiLabel'),
+                    hint: initText('prompts.portalType.aiHint'),
+                },
+            ],
+            initialValue: DEFAULT_INIT_PORTAL_TYPE,
+            yesInitialValue: DEFAULT_INIT_PORTAL_TYPE,
+            required: true,
+        }),
+        portalName: installNewOnly({
+            type: 'text',
+            message: initText('prompts.portalName.message'),
+            placeholder: DEFAULT_INIT_PORTAL_NAME,
+            initialValue: DEFAULT_INIT_PORTAL_NAME,
+            yesInitialValue: DEFAULT_INIT_PORTAL_NAME,
+            required: true,
+        }),
+        portalTemplate: installNewOnly({
+            type: 'text',
+            message: initText('prompts.portalTemplate.message'),
+            placeholder: DEFAULT_INIT_PORTAL_TEMPLATE,
+            yesInitialValue: DEFAULT_INIT_PORTAL_TEMPLATE,
+            hidden: (values) => !isAiMode(values),
+            required: true,
+        }),
         dbDialect: installLikeOnly(Install.dbPrompts.dbDialect),
         builtinDb: installLikeOnly(Install.dbPrompts.builtinDb),
         builtinDbImage: installLikeOnly(Install.dbPrompts.builtinDbImage),
@@ -413,6 +455,13 @@ Prompt modes:
             ...Init.prompts,
             installApiBaseUrl: createInstallConnectionApiBaseUrlPrompt(options.defaultApiHost),
         };
+        const defaultPortalTemplate = String(options.defaultPortalTemplate ?? '').trim();
+        if (defaultPortalTemplate) {
+            prompts.portalTemplate = {
+                ...prompts.portalTemplate,
+                yesInitialValue: defaultPortalTemplate,
+            };
+        }
         if (flags['skip-auth']) {
             const accessTokenPrompt = {
                 ...EnvAdd.prompts.accessToken,
@@ -462,6 +511,16 @@ Prompt modes:
             description: 'Setup mode: install a new app, manage a local app by reusing its database, or connect a remote app',
             options: [...INIT_SETUP_MODES],
         }),
+        'portal-type': Flags.string({
+            description: 'Initial portal type: no-code or ai',
+            options: [...INIT_PORTAL_TYPES],
+        }),
+        'portal-name': Flags.string({
+            description: 'Initial portal name',
+        }),
+        'portal-template': Flags.string({
+            description: 'Initial portal template npm package or local path when --portal-type ai is used',
+        }),
         ui: Flags.boolean({
             description: 'Open the guided setup flow in a local browser form (not valid with --yes)',
             default: false,
@@ -475,7 +534,7 @@ Prompt modes:
             default: false,
         }),
         'ui-host': Flags.string({
-            description: 'Host for the local --ui setup server (default: 127.0.0.1)',
+            description: 'Browser-accessible host for the --ui setup page URL (default: 127.0.0.1)',
         }),
         'ui-port': Flags.integer({
             description: 'Port for the local --ui setup server; 0 lets the OS choose an available port',
@@ -579,7 +638,8 @@ Prompt modes:
         const dynamicInitialValues = await Init.buildDynamicInitialValuesForInstall(normalizedFlags, presetValues);
         const defaultUiHost = await resolveDefaultUiHost();
         const defaultApiHost = await resolveDefaultApiHost();
-        const promptCatalog = this.buildPromptCatalog(normalizedFlags, { defaultApiHost });
+        const defaultPortalTemplate = String(dynamicInitialValues.portalTemplate ?? '').trim();
+        const promptCatalog = this.buildPromptCatalog(normalizedFlags, { defaultApiHost, defaultPortalTemplate });
         if (useBrowserUi) {
             presetValues = await runPromptCatalogWebUI({
                 stages: Init.buildWebUiStages(promptCatalog),
@@ -608,6 +668,7 @@ Prompt modes:
                     ? { setupMode: normalizeInitSetupMode(presetValues.hasNocobase) }
                     : {}),
             },
+            yesInitialValues: pickKeys(dynamicInitialValues, ['portalTemplate']),
             values: presetValues,
             yes: normalizedFlags.yes || useBrowserUi || !interactive,
             hooks: {
@@ -680,7 +741,9 @@ Prompt modes:
     }
     static async buildDynamicInitialValuesForInstall(flags, presetValues) {
         const out = {};
-        if (!Object.prototype.hasOwnProperty.call(presetValues, 'appPort')) {
+        const shouldResolveAppInitialValues = !Object.prototype.hasOwnProperty.call(presetValues, 'appPort') ||
+            !Object.prototype.hasOwnProperty.call(presetValues, 'portalTemplate');
+        if (shouldResolveAppInitialValues) {
             const appInitialValues = await Install.buildAppPromptInitialValues({
                 envName: String(presetValues.appName ?? '').trim(),
                 flags: {
@@ -688,17 +751,31 @@ Prompt modes:
                     'app-path': flags['app-path'] ?? '',
                     'app-root-path': flags['app-root-path'] ?? '',
                     'storage-path': flags['storage-path'] ?? '',
+                    'portal-template': flags['portal-template'] ??
+                        (Object.prototype.hasOwnProperty.call(presetValues, 'portalTemplate')
+                            ? String(presetValues.portalTemplate ?? '')
+                            : undefined),
                 },
                 warnOnPortFallback: false,
             });
-            if (appInitialValues.appPort !== undefined) {
+            if (appInitialValues.appPort !== undefined && !Object.prototype.hasOwnProperty.call(presetValues, 'appPort')) {
                 out.appPort = appInitialValues.appPort;
             }
+            if (appInitialValues.portalTemplate !== undefined &&
+                !Object.prototype.hasOwnProperty.call(presetValues, 'portalTemplate')) {
+                out.portalTemplate = appInitialValues.portalTemplate;
+            }
         }
         const downloadSeed = { ...presetValues };
         if (flags.yes && !Object.prototype.hasOwnProperty.call(downloadSeed, 'source')) {
             downloadSeed.source = 'docker';
         }
+        const builtinDbImageRegistry = String(presetValues.dockerRegistry ?? '').trim() ||
+            resolveOfficialDockerRegistry(await getCliConfigValue('nb-image-registry'));
+        if (!Object.prototype.hasOwnProperty.call(presetValues, 'dockerRegistry')) {
+            out.dockerRegistry = builtinDbImageRegistry;
+        }
+        out.builtinDbImageRegistry = builtinDbImageRegistry;
         const dbInitial = await Install.buildDbPromptInitialValues({
             flags,
             downloadResults: downloadSeed,
@@ -706,6 +783,9 @@ Prompt modes:
             warnOnPortFallback: false,
         });
         for (const [key, value] of Object.entries(dbInitial)) {
+            if (key === 'builtinDbImage') {
+                continue;
+            }
             if (!Object.prototype.hasOwnProperty.call(presetValues, key)) {
                 out[key] = value;
             }
@@ -763,6 +843,14 @@ Prompt modes:
                     buildDts: c.buildDts,
                 },
             },
+            {
+                sectionTitle: initText('webUi.portalType.title'),
+                sectionDescription: initText('webUi.portalType.description'),
+                catalog: {
+                    portalName: c.portalName,
+                    portalType: c.portalType,
+                },
+            },
             {
                 sectionTitle: initText('webUi.configureDatabase.title'),
                 sectionDescription: initText('webUi.configureDatabase.description'),
@@ -863,6 +951,15 @@ Prompt modes:
         if (flags['app-public-path'] !== undefined && String(flags['app-public-path']).trim() !== '') {
             preset.appPublicPath = String(flags['app-public-path']).trim();
         }
+        if (flags['portal-type'] !== undefined && String(flags['portal-type']).trim() !== '') {
+            preset.portalType = String(flags['portal-type']).trim();
+        }
+        if (flags['portal-name'] !== undefined && String(flags['portal-name']).trim() !== '') {
+            preset.portalName = String(flags['portal-name']).trim();
+        }
+        if (flags['portal-template'] !== undefined && String(flags['portal-template']).trim() !== '') {
+            preset.portalTemplate = String(flags['portal-template']).trim();
+        }
         if (flags['root-username'] !== undefined) {
             preset.rootUsername = String(flags['root-username'] ?? '').trim();
         }
@@ -1000,6 +1097,9 @@ Prompt modes:
         const existingEnv = await getEnv(envName, { scope: resolveDefaultConfigScope() });
         const appPort = String(results.appPort ?? '').trim();
         const appPublicPath = String(results.appPublicPath ?? '').trim();
+        const portalType = String(results.portalType ?? '').trim();
+        const portalName = String(results.portalName ?? '').trim();
+        const portalTemplate = String(results.portalTemplate ?? '').trim();
         const source = String(results.source ?? '').trim();
         const version = resolveInitDownloadVersion(results);
         const dockerRegistry = String(results.dockerRegistry ?? '').trim();
@@ -1032,6 +1132,14 @@ Prompt modes:
         const skipDownload = results.skipDownload === true;
         const appKey = resolveManagedAppKey(results.appKey ?? existingEnv?.config.appKey);
         const timeZone = resolveManagedTimeZone(results.timeZone ?? existingEnv?.config.timezone);
+        const hookScriptInput = String(flags['hook-script'] ?? '').trim();
+        const hookAppPath = appPath || `./${envName}/`;
+        const hookScript = hookScriptInput
+            ? await persistHookScript({
+                sourcePath: hookScriptInput,
+                appPath: resolveConfiguredEnvPath(hookAppPath) ?? resolveEnvRelativePath(hookAppPath),
+            })
+            : String(results.hookScript ?? '').trim();
         const builtinDb = explicitDbHostFlag(flags)
             ? false
             : results.builtinDb === undefined
@@ -1040,6 +1148,7 @@ Prompt modes:
         results.appKey = appKey;
         results.timeZone = timeZone;
         await upsertEnv(envName, {
+            schemaVersion: ENV_CONFIG_SCHEMA_VERSION,
             ...(source === 'docker'
                 ? { kind: 'docker' }
                 : source || appPath || appRootPath
@@ -1057,11 +1166,15 @@ Prompt modes:
             ...(dockerPlatform ? { dockerPlatform } : {}),
             ...(gitUrl ? { gitUrl } : {}),
             ...(npmRegistry ? { npmRegistry } : {}),
+            ...(hookScript ? { hookScript } : {}),
             ...(appPath ? { appPath } : {}),
             ...(appRootPath && !areConfiguredPathsEquivalent(appRootPath, derivedAppRootPath) ? { appRootPath } : {}),
             ...(storagePath && !areConfiguredPathsEquivalent(storagePath, derivedStoragePath) ? { storagePath } : {}),
             ...(appPort ? { appPort } : {}),
             ...(appPublicPath ? { appPublicPath } : {}),
+            ...(portalType && portalType !== DEFAULT_INIT_PORTAL_TYPE ? { portalType } : {}),
+            ...(portalName ? { portalName } : {}),
+            ...(portalTemplate ? { portalTemplate } : {}),
             ...(appKey ? { appKey } : {}),
             ...(timeZone ? { timezone: timeZone } : {}),
             ...(!skipDownload && results.devDependencies !== undefined
@@ -1132,6 +1245,10 @@ Prompt modes:
         if (flags['prepare-only']) {
             argv.push('--prepare-only');
         }
+        const hookScript = String(results.hookScript ?? flags['hook-script'] ?? '').trim();
+        if (hookScript) {
+            argv.push('--hook-script', hookScript);
+        }
         if (flags.verbose) {
             argv.push('--verbose');
         }
@@ -1182,6 +1299,18 @@ Prompt modes:
         if (appPublicPath) {
             argv.push('--app-public-path', appPublicPath);
         }
+        const portalType = String(results.portalType ?? '').trim();
+        if (portalType && portalType !== DEFAULT_INIT_PORTAL_TYPE) {
+            argv.push('--portal-type', portalType);
+        }
+        const portalName = String(results.portalName ?? '').trim();
+        if (portalName) {
+            argv.push('--portal-name', portalName);
+        }
+        const portalTemplate = String(results.portalTemplate ?? '').trim();
+        if (portalTemplate) {
+            argv.push('--portal-template', portalTemplate);
+        }
         if (flags.force) {
             argv.push('--force');
         }
@@ -1379,6 +1508,15 @@ Prompt modes:
             delete normalized.rootPassword;
             delete normalized.rootNickname;
         }
+        const portalType = normalizeConnectionString(normalized.portalType) || DEFAULT_INIT_PORTAL_TYPE;
+        normalized.portalType = portalType;
+        normalized.portalName = normalizeConnectionString(normalized.portalName) || DEFAULT_INIT_PORTAL_NAME;
+        if (portalType === 'ai') {
+            normalized.portalTemplate = normalizeConnectionString(normalized.portalTemplate);
+        }
+        else {
+            delete normalized.portalTemplate;
+        }
         delete normalized.installApiBaseUrl;
         delete normalized.installAuthType;
         delete normalized.installUsername;