@nocobase/cli 2.2.0-beta.8 → 2.2.0-test.15

package/dist/commands/portal/create.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 { Args, Command, Flags } from '@oclif/core';
+import { getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { createPortalWorkspace } from '../../lib/portal-create.js';
+import { printInfo, printSuccess } from '../../lib/ui.js';
+const DEFAULT_PORTAL_TEMPLATE = '@nocobase/portal-template-default';
+const portalCreateText = (key, values, fallback) => translateCli(`commands.portalCreate.${key}`, values, { fallback });
+export default class PortalCreate extends Command {
+    static summary = 'Create a local Portal workspace from a template';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --template @nocobase/portal-template-default',
+        '<%= config.bin %> <%= command.id %> customer --env dev --yes',
+        '<%= config.bin %> <%= command.id %> customer --source-storage git --git-repo git@github.com:nocobase/customer-portal.git',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        template: Flags.string({
+            description: 'Template package, local path, or file:// URL',
+            default: DEFAULT_PORTAL_TEMPLATE,
+        }),
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        title: Flags.string({
+            description: 'Portal display title; defaults to a title generated from the portal slug',
+        }),
+        force: Flags.boolean({
+            description: 'Delete the existing Portal workspace and recreate it',
+            default: false,
+        }),
+        'source-storage': Flags.string({
+            description: 'Where Portal source code is managed',
+            options: ['nocobase', 'git'],
+            default: 'nocobase',
+        }),
+        'git-repo': Flags.string({
+            description: 'Git repository URL used when --source-storage=git',
+        }),
+        'git-branch': Flags.string({
+            description: 'Git branch used when --source-storage=git',
+            default: 'main',
+        }),
+        'git-path': Flags.string({
+            description: 'Directory inside the Git repository for this Portal; defaults to the portal slug',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalCreate);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const env = await getEnv(flags.env, { scope: resolveDefaultConfigScope() });
+        if (!env) {
+            this.error(flags.env
+                ? portalCreateText('errors.envNotConfigured', { envName: flags.env }, `Env "${flags.env}" is not configured. Run \`nb env add ${flags.env} --api-base-url <url>\` first.`)
+                : portalCreateText('errors.noEnvConfigured', undefined, 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await createPortalWorkspace({
+            portal: args.portal,
+            title: flags.title,
+            template: flags.template,
+            env,
+            envName: flags.env,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+            force: flags.force,
+            sourceStorage: flags['source-storage'],
+            gitRepo: flags['git-repo'],
+            gitBranch: flags['git-branch'],
+            gitPath: flags['git-path'],
+            onSkipInstall: (message) => printInfo(message),
+        });
+        printSuccess(portalCreateText('messages.created', { portal: result.portal, portalDir: result.portalDir }, `Portal "${result.portal}" created at ${result.portalDir}.`));
+        printInfo(portalCreateText('messages.app', { app: result.app }, `App: ${result.app}`));
+        printInfo(portalCreateText('messages.base', { base: result.portalBase }, `Base: ${result.portalBase}`));
+        printInfo(portalCreateText('messages.sourceStorage', { sourceStorage: result.sourceStorage }, `Source storage: ${result.sourceStorage}`));
+    }
+}

package/dist/commands/portal/deploy.js

@@ -0,0 +1,81 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { findPortalListItem, formatPortalInfo } from '../../lib/portal-info.js';
+import { deployPortalWorkspace } from '../../lib/portal-deploy.js';
+import { listPortalWorkspaces } from '../../lib/portal-list.js';
+import { printSuccess } from '../../lib/ui.js';
+const portalDeployText = (key, values, fallback) => translateCli(`commands.portalDeploy.${key}`, values, { fallback });
+export default class PortalDeploy extends Command {
+    static summary = 'Build and deploy a Portal workspace';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --env dev --yes',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalDeploy);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalDeployText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await deployPortalWorkspace({
+            portal: args.portal,
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+        });
+        printSuccess(portalDeployText('messages.deployed', { portal: result.portal }, `Portal "${result.portal}" deployed.`));
+        const info = await listPortalWorkspaces({
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+        });
+        const portal = findPortalListItem(info.items, result.portal);
+        if (!portal) {
+            this.error(translateCli(`commands.portalInfo.errors.notFound`, { portal: result.portal }, {
+                fallback: `Portal "${result.portal}" was not found.`,
+            }));
+        }
+        this.log(formatPortalInfo(portal));
+    }
+}

package/dist/commands/portal/destroy.js

@@ -0,0 +1,104 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { confirm } from "../../lib/inquirer.js";
+import { destroyPortalWorkspace } from '../../lib/portal-destroy.js';
+import { isInteractiveTerminal, printInfo, printSuccess } from '../../lib/ui.js';
+const portalDestroyText = (key, values, fallback) => translateCli(`commands.portalDestroy.${key}`, values, { fallback });
+async function ensureDestroyConfirmed(options) {
+    if (options.yes) {
+        return true;
+    }
+    if (!isInteractiveTerminal()) {
+        options.command.error(portalDestroyText('errors.confirmationRequired', undefined, 'Refusing to destroy a Portal in non-interactive mode without --yes.'));
+    }
+    try {
+        return Boolean(await confirm({
+            message: portalDestroyText('prompts.confirm', { portal: options.portal }, `Destroy Portal "${options.portal}" and delete its storage directory?`),
+            default: false,
+        }));
+    }
+    catch {
+        return false;
+    }
+}
+export default class PortalDestroy extends Command {
+    static summary = 'Destroy a Portal record and its local workspace';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer --yes',
+        '<%= config.bin %> <%= command.id %> customer --env dev --yes',
+        '<%= config.bin %> <%= command.id %> customer --force --yes',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip confirmation prompts',
+            default: false,
+        }),
+        force: Flags.boolean({
+            description: 'Ignore missing Portal records or workspace directories',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalDestroy);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const crossEnvConfirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!crossEnvConfirmed) {
+            return;
+        }
+        const destroyConfirmed = await ensureDestroyConfirmed({
+            command: this,
+            portal: args.portal,
+            yes: flags.yes,
+        });
+        if (!destroyConfirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalDestroyText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await destroyPortalWorkspace({
+            portal: args.portal,
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+            force: flags.force,
+        });
+        printSuccess(portalDestroyText('messages.destroyed', { portal: result.portal }, `Portal "${result.portal}" destroyed.`));
+        printInfo(portalDestroyText('messages.mode', { mode: result.mode }, `Mode: ${result.mode}`));
+        printInfo(portalDestroyText('messages.app', { app: result.app }, `App: ${result.app}`));
+        printInfo(portalDestroyText('messages.base', { base: result.portalBase }, `Base: ${result.portalBase}`));
+        printInfo(portalDestroyText('messages.record', { status: result.recordDeleted ? 'deleted' : 'missing' }, `Record: ${result.recordDeleted ? 'deleted' : 'missing'}`));
+        printInfo(portalDestroyText('messages.workspace', { dir: result.portalDir, status: result.workspaceDeleted ? 'deleted' : 'missing' }, `Workspace: ${result.workspaceDeleted ? 'deleted' : 'missing'} (${result.portalDir})`));
+    }
+}

package/dist/commands/portal/dev.js

@@ -0,0 +1,71 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { devPortalWorkspace } from '../../lib/portal-dev.js';
+import { printInfo } from '../../lib/ui.js';
+const portalDevText = (key, values, fallback) => translateCli(`commands.portalDev.${key}`, values, { fallback });
+export default class PortalDev extends Command {
+    static summary = 'Start a Portal workspace in development mode';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --env dev --yes',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalDev);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalDevText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        await devPortalWorkspace({
+            portal: args.portal,
+            env,
+            onStart: (result) => {
+                printInfo(portalDevText('messages.starting', { portal: result.portal }, `Starting Portal "${result.portal}"...`));
+                printInfo(portalDevText('messages.mode', { mode: result.mode }, `Mode: ${result.mode}`));
+                printInfo(portalDevText('messages.app', { app: result.app }, `App: ${result.app}`));
+                printInfo(portalDevText('messages.base', { base: result.portalBase }, `Base: ${result.portalBase}`));
+                printInfo(portalDevText('messages.dir', { dir: result.portalDir }, `Dir: ${result.portalDir}`));
+            },
+        });
+    }
+}

package/dist/commands/portal/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 Portal extends Command {
+    static summary = 'Manage Portal workspaces';
+    async run() {
+        await this.parse(Portal);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'portal',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/portal/info.js

@@ -0,0 +1,82 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { findPortalListItem, formatPortalInfo } from '../../lib/portal-info.js';
+import { listPortalWorkspaces, toPortalOutputItem } from '../../lib/portal-list.js';
+const portalInfoText = (key, values, fallback) => translateCli(`commands.portalInfo.${key}`, values, { fallback });
+export default class PortalInfo extends Command {
+    static summary = 'Show Portal record and local workspace details';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --env dev --yes',
+        '<%= config.bin %> <%= command.id %> customer --json',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        'json-output': Flags.boolean({
+            char: 'j',
+            aliases: ['json'],
+            description: 'Print Portal details as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalInfo);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalInfoText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await listPortalWorkspaces({
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+        });
+        const portal = findPortalListItem(result.items, args.portal);
+        if (!portal) {
+            this.error(portalInfoText('errors.notFound', { portal: args.portal }, `Portal "${args.portal}" was not found.`));
+        }
+        const outputItem = toPortalOutputItem(portal);
+        if (flags['json-output']) {
+            this.log(JSON.stringify(outputItem, null, 2));
+            return;
+        }
+        this.log(formatPortalInfo(portal));
+    }
+}

package/dist/commands/portal/list.js

@@ -0,0 +1,98 @@
+/**
+ * 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 { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { listPortalWorkspaces, toPortalOutputItem } from '../../lib/portal-list.js';
+import { printInfo, renderTable } from '../../lib/ui.js';
+const portalListText = (key, values, fallback) => translateCli(`commands.portalList.${key}`, values, { fallback });
+function formatBoolean(value) {
+    if (value === null) {
+        return '';
+    }
+    return value ? 'yes' : 'no';
+}
+export default class PortalList extends Command {
+    static summary = 'List Portal records and local workspace sync status';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env dev --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        'json-output': Flags.boolean({
+            char: 'j',
+            aliases: ['json'],
+            description: 'Print Portal records as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(PortalList);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalListText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await listPortalWorkspaces({
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+        });
+        const outputItems = result.items.map(toPortalOutputItem);
+        if (flags['json-output']) {
+            this.log(JSON.stringify(outputItems, null, 2));
+            return;
+        }
+        if (!outputItems.length) {
+            printInfo(portalListText('messages.empty', undefined, 'No Portal records found.'));
+            return;
+        }
+        this.log(renderTable([
+            portalListText('table.name', undefined, 'Name'),
+            portalListText('table.url', undefined, 'URL'),
+            portalListText('table.developmentMode', undefined, 'Development mode'),
+            portalListText('table.sourceStorage', undefined, 'Source storage'),
+            portalListText('table.path', undefined, 'Local path'),
+            portalListText('table.enabled', undefined, 'Enabled'),
+            portalListText('table.localSynced', undefined, 'Local synced'),
+        ], outputItems.map((item) => [
+            item.name,
+            item.url,
+            item.developmentMode,
+            item.sourceStorage,
+            item.localPath,
+            formatBoolean(item.enabled),
+            formatBoolean(item.localSynced),
+        ])));
+    }
+}

package/dist/commands/portal/pull.js

@@ -0,0 +1,77 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command, Flags } from '@oclif/core';
+import { getCurrentEnvName, getEnv } from '../../lib/auth-store.js';
+import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
+import { translateCli } from '../../lib/cli-locale.js';
+import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
+import { pullPortalSource } from '../../lib/portal-source.js';
+import { printInfo, printSuccess } from '../../lib/ui.js';
+const portalPullText = (key, values, fallback) => translateCli(`commands.portalPull.${key}`, values, { fallback });
+export default class PortalPull extends Command {
+    static summary = 'Pull Portal source into the local workspace';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> customer',
+        '<%= config.bin %> <%= command.id %> customer --env prod --yes',
+        '<%= config.bin %> <%= command.id %> customer --force',
+    ];
+    static args = {
+        portal: Args.string({
+            required: true,
+            description: 'Portal name/slug',
+        }),
+    };
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name; omitted uses the current env',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Confirm using --env when it targets a different env than the current env',
+            default: false,
+        }),
+        force: Flags.boolean({
+            description: 'Delete the existing local workspace and pull it again',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(PortalPull);
+        const requestedEnv = hasExplicitEnvSelection(this.argv) ? flags.env : undefined;
+        const confirmed = await ensureCrossEnvConfirmed({
+            command: this,
+            requestedEnv,
+            yes: flags.yes,
+        });
+        if (!confirmed) {
+            return;
+        }
+        const scope = resolveDefaultConfigScope();
+        const envName = requestedEnv ?? (await getCurrentEnvName({ scope }));
+        const env = await getEnv(envName, { scope });
+        if (!env) {
+            this.error(portalPullText(requestedEnv ? 'errors.envNotConfigured' : 'errors.noEnvConfigured', { envName }, requestedEnv
+                ? `Env "${envName}" is not configured. Run \`nb env add ${envName} --api-base-url <url>\` first.`
+                : 'No NocoBase env is configured yet. Run `nb init --ui` to create one first.'));
+        }
+        const result = await pullPortalSource({
+            portal: args.portal,
+            env,
+            envName,
+            cliVersion: String(this.config.pjson.version ?? '').trim(),
+            force: flags.force,
+        });
+        if (!result.changed) {
+            printInfo(result.noopReason ?? portalPullText('messages.noop', undefined, 'No pull is needed.'));
+            return;
+        }
+        printSuccess(portalPullText('messages.pulled', { portal: result.portal, portalDir: result.portalDir }, `Pulled Portal source "${result.portal}" into ${result.portalDir}.`));
+    }
+}