@nocobase/cli 2.1.0-alpha.4 → 2.1.0-alpha.40

package/dist/commands/session/id.js

@@ -0,0 +1,24 @@
+/**
+ * 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 { resolveSessionIdentity } from '../../lib/session-id.js';
+export default class SessionId extends Command {
+    static summary = 'Show the current effective session id';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    async run() {
+        await this.parse(SessionId);
+        const identity = resolveSessionIdentity();
+        if (!identity) {
+            this.error('No effective session id is available. Run `nb session setup`, then open a new shell session or runtime.');
+        }
+        this.log(identity.id);
+    }
+}

package/dist/commands/session/remove.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.
+ */
+/**
+ * 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 { detectSessionShell, removeSessionIntegration } from '../../lib/session-integration.js';
+export default class SessionRemove extends Command {
+    static summary = 'Remove shell session integration for NB_SESSION_ID';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --shell zsh',
+    ];
+    static flags = {
+        shell: Flags.string({
+            description: 'Target shell to remove configuration from',
+            options: ['bash', 'zsh', 'fish', 'powershell', 'cmd'],
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SessionRemove);
+        const shell = flags.shell ?? detectSessionShell();
+        if (!shell) {
+            this.error('Could not detect the current shell. Re-run with `--shell bash|zsh|fish|powershell|cmd`.');
+        }
+        const result = await removeSessionIntegration(shell);
+        this.log(`Session integration removed for ${result.shell}.`);
+        if (result.profileUpdated) {
+            for (const profileFile of result.profileFiles) {
+                this.log(`Profile updated: ${profileFile}`);
+            }
+        }
+        if (result.managedFileRemoved) {
+            this.log(`Managed file removed: ${result.managedFile}`);
+        }
+        if (result.cmdAutoRunRemoved) {
+            this.log(`cmd AutoRun updated: ${result.cmdAutoRunLocation}`);
+        }
+        if (result.agentConfigUpdated) {
+            this.log(`Opencode config updated: ${result.agentConfigFile}`);
+        }
+        if (result.agentPluginRemoved) {
+            this.log(`Opencode agent plugin removed: ${result.agentPluginFile}`);
+        }
+    }
+}

package/dist/commands/session/setup.js

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ * 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 { detectSessionShell, setupSessionIntegration } from '../../lib/session-integration.js';
+export default class SessionSetup extends Command {
+    static summary = 'Set up shell session integration for NB_SESSION_ID';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --shell zsh',
+        '<%= config.bin %> <%= command.id %> --shell powershell',
+    ];
+    static flags = {
+        shell: Flags.string({
+            description: 'Target shell to configure',
+            options: ['bash', 'zsh', 'fish', 'powershell', 'cmd'],
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SessionSetup);
+        const shell = flags.shell ?? detectSessionShell();
+        if (!shell) {
+            this.error('Could not detect the current shell. Re-run with `--shell bash|zsh|fish|powershell|cmd`.');
+        }
+        const result = await setupSessionIntegration(shell);
+        this.log(`Session integration configured for ${result.shell}.`);
+        this.log(`Managed file: ${result.managedFile}`);
+        if (result.cmdAutoRunConfigured) {
+            this.log(`cmd AutoRun updated: ${result.cmdAutoRunLocation}`);
+            this.log('Open a new cmd session to initialize NB_SESSION_ID automatically.');
+        }
+        if (result.agentConfigured) {
+            this.log(`Opencode agent plugin installed: ${result.agentPluginFile}`);
+            this.log(`Opencode config updated: ${result.agentConfigFile}`);
+        }
+        else if (result.agentSkippedReason === 'opencode_dir_not_found') {
+            this.log('Opencode config directory not found. Skipped agent session integration.');
+        }
+        if (result.profileFiles.length > 0) {
+            for (const profileFile of result.profileFiles) {
+                this.log(`Profile updated: ${profileFile}`);
+            }
+            this.log('Open a new shell session or reload your profile to initialize NB_SESSION_ID automatically.');
+        }
+        if (result.manualStep) {
+            this.log(result.manualStep);
+        }
+    }
+}

package/dist/commands/skills/check.js

@@ -0,0 +1,69 @@
+/**
+ * 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 { inspectSkillsStatus } from '../../lib/skills-manager.js';
+import { printInfo, renderTable } from '../../lib/ui.js';
+export default class SkillsCheck extends Command {
+    static summary = 'Check the globally installed NocoBase AI coding skills';
+    static description = 'Inspect the global NocoBase AI coding skills and report whether they are managed by the CLI and whether an update is available.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsCheck);
+        const status = await inspectSkillsStatus();
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                globalRoot: status.globalRoot,
+                workspaceRoot: status.workspaceRoot,
+                installed: status.installed,
+                managedByNb: status.managedByNb,
+                sourcePackage: status.sourcePackage,
+                npmPackageName: status.npmPackageName,
+                installedSkillNames: status.installedSkillNames,
+                installedVersion: status.installedVersion,
+                latestVersion: status.latestVersion,
+                installedRef: status.installedRef,
+                latestRef: status.latestRef,
+                updateAvailable: status.updateAvailable,
+                recommendedCommand: status.installed ? 'nb skills update --yes' : 'nb skills install --yes',
+                registryError: status.registryError,
+            }, null, 2));
+            return;
+        }
+        this.log(renderTable(['Field', 'Value'], [
+            ['Skills home', status.globalRoot],
+            ['Installed', status.installed ? 'yes' : 'no'],
+            ['Managed by nb', status.managedByNb ? 'yes' : 'no'],
+            ['Installed skills', status.installedSkillNames.length ? status.installedSkillNames.join(', ') : '(none)'],
+            ['Installed version', status.installedVersion ?? '(unknown)'],
+            ['Latest version', status.latestVersion ?? '(unknown)'],
+            ['Update available', status.updateAvailable === null ? 'unknown' : status.updateAvailable ? 'yes' : 'no'],
+        ]));
+        if (!status.installed) {
+            printInfo('Run `nb skills install` to install the NocoBase AI coding skills globally.');
+            return;
+        }
+        if (status.updateAvailable) {
+            printInfo('Run `nb skills update` to refresh the global NocoBase AI coding skills.');
+        }
+        if (status.registryError) {
+            printInfo(`Update check warning: ${status.registryError}`);
+        }
+    }
+}

package/dist/commands/skills/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 Skills extends Command {
+    static summary = 'Inspect or synchronize global NocoBase AI coding skills';
+    async run() {
+        await this.parse(Skills);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'skills',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/skills/install.js

@@ -0,0 +1,80 @@
+/**
+ * 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 { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { installNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsInstall extends Command {
+    static summary = 'Install the NocoBase AI coding skills globally';
+    static description = 'Install the NocoBase AI coding skills globally. If they are already installed, this command does not update them.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the install confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed install output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsInstall);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Install the NocoBase AI coding skills globally?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await installNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are already installed globally. Run `nb skills update` to refresh them.'
+                : 'NocoBase AI coding skills are already installed globally.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Installed the NocoBase AI coding skills globally.'
+            : 'Installed NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/skills/remove.js

@@ -0,0 +1,80 @@
+/**
+ * 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 { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { removeNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsRemove extends Command {
+    static summary = 'Remove the globally installed NocoBase AI coding skills';
+    static description = 'Remove the skills installed from nocobase/skills globally. This only removes the skills managed by `nb`.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the remove confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed remove output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsRemove);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Remove the globally installed NocoBase AI coding skills?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await removeNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are not installed globally.'
+                : 'NocoBase AI coding skills are not installed.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Removed the global NocoBase AI coding skills.'
+            : 'Removed NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/skills/update.js

@@ -0,0 +1,87 @@
+/**
+ * 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 { confirm } from "../../lib/inquirer.js";
+import { setVerboseMode } from '../../lib/ui.js';
+import { updateNocoBaseSkills } from '../../lib/skills-manager.js';
+export default class SkillsUpdate extends Command {
+    static summary = 'Update the globally installed NocoBase AI coding skills';
+    static description = 'Refresh the globally installed NocoBase AI coding skills. This command only updates an existing @nocobase/skills install.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --yes',
+        '<%= config.bin %> <%= command.id %> --json',
+    ];
+    static flags = {
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'Skip the update confirmation prompt',
+            default: false,
+        }),
+        json: Flags.boolean({
+            description: 'Output the result as JSON',
+            default: false,
+        }),
+        verbose: Flags.boolean({
+            description: 'Show detailed update output',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SkillsUpdate);
+        setVerboseMode(flags.verbose);
+        if (!flags.yes) {
+            let confirmed = false;
+            try {
+                confirmed = await confirm({
+                    message: 'Update the globally installed NocoBase AI coding skills?',
+                    default: true,
+                });
+            }
+            catch {
+                return;
+            }
+            if (!confirmed) {
+                return;
+            }
+        }
+        const result = await updateNocoBaseSkills({
+            verbose: flags.verbose,
+        });
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: true,
+                kind: 'skills',
+                action: result.action,
+                reason: result.action === 'noop' ? result.reason : undefined,
+                globalRoot: result.status.globalRoot,
+                workspaceRoot: result.status.workspaceRoot,
+                installedSkillNames: result.status.installedSkillNames,
+                installedVersion: result.status.installedVersion,
+                installedRef: result.status.installedRef,
+            }, null, 2));
+            return;
+        }
+        if (result.action === 'noop') {
+            if (result.reason === 'not-installed') {
+                this.log(flags.verbose
+                    ? 'NocoBase AI coding skills are not installed globally. Run `nb skills install` first.'
+                    : 'Skipped skills update because NocoBase AI coding skills are not installed.');
+                return;
+            }
+            this.log(flags.verbose
+                ? 'NocoBase AI coding skills are already up to date globally.'
+                : 'NocoBase AI coding skills are up to date.');
+            return;
+        }
+        this.log(flags.verbose
+            ? 'Updated the global NocoBase AI coding skills.'
+            : 'Updated NocoBase AI coding skills globally.');
+    }
+}

package/dist/commands/source/build.js

@@ -0,0 +1,58 @@
+/**
+ * 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 { runNocoBaseCommand } from "../../lib/run-npm.js";
+import { setVerboseMode } from '../../lib/ui.js';
+export default class SourceBuild extends Command {
+    static hidden = false;
+    static args = {
+        /** Matches `nb source build @nocobase/acl @nocobase/actions` — zero or more package names. */
+        packages: Args.string({
+            description: 'package names to build',
+            multiple: true,
+            required: false,
+        }),
+    };
+    static description = 'Run the legacy NocoBase build for the local source project (forwards to `npm run build` in the repo root)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --no-dts',
+        '<%= config.bin %> <%= command.id %> --sourcemap',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl @nocobase/actions',
+    ];
+    static flags = {
+        'cwd': Flags.string({ description: 'Current working directory', char: 'c', required: false }),
+        'no-dts': Flags.boolean({ description: 'not generate dts' }),
+        sourcemap: Flags.boolean({ description: 'generate sourcemap' }),
+        verbose: Flags.boolean({ description: 'Show detailed command output', default: false }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(SourceBuild);
+        setVerboseMode(flags.verbose);
+        const packages = args.packages ?? [];
+        const npmArgs = ['build', ...packages];
+        if (flags['no-dts']) {
+            npmArgs.push('--no-dts');
+        }
+        if (flags.sourcemap) {
+            npmArgs.push('--sourcemap');
+        }
+        try {
+            await runNocoBaseCommand(npmArgs, {
+                cwd: flags['cwd'],
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(message);
+        }
+    }
+}