@nocobase/cli 2.1.0-alpha.24 → 2.1.0-alpha.26

package/dist/lib/startup-update.js

@@ -0,0 +1,203 @@
+/**
+ * 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 fs from 'node:fs/promises';
+import path from 'node:path';
+import * as p from '@clack/prompts';
+import { inspectSelfStatus, } from './self-manager.js';
+import { inspectSkillsStatus } from './skills-manager.js';
+import { resolveCliHomeDir } from './cli-home.js';
+import { isInteractiveTerminal, printWarning } from './ui.js';
+import { run } from './run-npm.js';
+const STARTUP_UPDATE_STATE_FILE = 'startup-update.json';
+const NB_SKIP_STARTUP_UPDATE_ENV = 'NB_SKIP_STARTUP_UPDATE';
+function getStateFile() {
+    return path.join(resolveCliHomeDir('global'), STARTUP_UPDATE_STATE_FILE);
+}
+function todayStamp(now = new Date()) {
+    return now.toISOString().slice(0, 10);
+}
+function shouldSkipByArgv(argv) {
+    const tokens = argv.filter((token) => token && !token.startsWith('-'));
+    if (tokens.length === 0) {
+        return false;
+    }
+    if (tokens[0] === 'self' || tokens[0] === 'skills') {
+        return true;
+    }
+    return false;
+}
+async function readState() {
+    try {
+        const raw = await fs.readFile(getStateFile(), 'utf8');
+        return JSON.parse(raw);
+    }
+    catch {
+        return {};
+    }
+}
+async function writeState(state) {
+    const filePath = getStateFile();
+    await fs.mkdir(path.dirname(filePath), { recursive: true });
+    await fs.writeFile(filePath, JSON.stringify(state, null, 2));
+}
+async function markChecked(now = new Date()) {
+    await writeState({ lastCheckedDate: todayStamp(now) });
+}
+export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
+    if (process.env[NB_SKIP_STARTUP_UPDATE_ENV] === '1') {
+        return false;
+    }
+    if (shouldSkipByArgv(argv)) {
+        return false;
+    }
+    const state = await readState();
+    return state.lastCheckedDate !== todayStamp(now);
+}
+export function shouldEnableStartupUpdateForInstallMethod(installMethod) {
+    return installMethod === 'npm-global';
+}
+function hasPendingUpdates(selfStatus, skillsStatus) {
+    return Boolean(selfStatus.updateAvailable || skillsStatus.updateAvailable === true);
+}
+function describeCliUpdate(selfStatus) {
+    return selfStatus.latestVersion
+        ? `NocoBase CLI: ${selfStatus.currentVersion} -> ${selfStatus.latestVersion}`
+        : `NocoBase CLI: update available from ${selfStatus.currentVersion}`;
+}
+function describeSkillsUpdate() {
+    return 'NocoBase AI skills: update available';
+}
+function describeSkillsUpdateWithVersion(skillsStatus) {
+    if (skillsStatus.installedVersion && skillsStatus.latestVersion) {
+        return `NocoBase AI skills: ${skillsStatus.installedVersion} -> ${skillsStatus.latestVersion}`;
+    }
+    if (skillsStatus.latestVersion) {
+        return `NocoBase AI skills: latest ${skillsStatus.latestVersion} available`;
+    }
+    return describeSkillsUpdate();
+}
+function buildPromptMessage(selfStatus, skillsStatus) {
+    const lines = [];
+    const hasCliUpdate = selfStatus.updateAvailable;
+    const hasSkillsUpdate = skillsStatus.updateAvailable === true;
+    if (hasCliUpdate && hasSkillsUpdate) {
+        lines.push('Updates are available for your NocoBase CLI and AI skills.');
+    }
+    else if (hasCliUpdate) {
+        lines.push('An update is available for your NocoBase CLI.');
+    }
+    else if (hasSkillsUpdate) {
+        lines.push('An update is available for your NocoBase AI skills.');
+    }
+    else {
+        lines.push('A NocoBase CLI or skills update is available.');
+    }
+    if (hasCliUpdate) {
+        lines.push(`- ${describeCliUpdate(selfStatus)}`);
+    }
+    if (hasSkillsUpdate) {
+        lines.push(`- ${describeSkillsUpdateWithVersion(skillsStatus)}`);
+    }
+    lines.push('Update now?');
+    return lines.join('\n');
+}
+function buildUpdateCommands(selfStatus, skillsStatus) {
+    const commands = [];
+    if (selfStatus.updateAvailable && selfStatus.updatable) {
+        commands.push('nb self update --yes');
+    }
+    if (skillsStatus.updateAvailable === true) {
+        commands.push('nb skills update --yes');
+    }
+    return commands;
+}
+function buildNonInteractiveWarning(selfStatus, skillsStatus) {
+    const commands = buildUpdateCommands(selfStatus, skillsStatus);
+    const details = [];
+    if (selfStatus.updateAvailable) {
+        details.push(describeCliUpdate(selfStatus));
+    }
+    if (skillsStatus.updateAvailable === true) {
+        details.push(describeSkillsUpdateWithVersion(skillsStatus));
+    }
+    return [
+        `Updates available${details.length ? `: ${details.join(', ')}` : '.'}`,
+        'Non-interactive session, skipped auto-update.',
+        commands.length
+            ? `Run: ${commands.join(' && ')}`
+            : 'Check with: `nb self check` and `nb skills check`.',
+        'You may run into compatibility issues until you update.',
+    ].join(' ');
+}
+function buildDeclinedWarning(selfStatus, skillsStatus) {
+    const commands = buildUpdateCommands(selfStatus, skillsStatus);
+    const details = [];
+    if (selfStatus.updateAvailable) {
+        details.push(describeCliUpdate(selfStatus));
+    }
+    if (skillsStatus.updateAvailable === true) {
+        details.push(describeSkillsUpdateWithVersion(skillsStatus));
+    }
+    return [
+        `Skipped updates${details.length ? `: ${details.join(', ')}` : '.'}`,
+        commands.length
+            ? `Run: ${commands.join(' && ')}`
+            : 'Check with: `nb self check` and `nb skills check`.',
+        'You may run into compatibility issues until you update.',
+    ].join(' ');
+}
+async function runStartupUpdates() {
+    await run('nb', ['self', 'update', '--yes'], {
+        stdio: 'inherit',
+        env: {
+            [NB_SKIP_STARTUP_UPDATE_ENV]: '1',
+        },
+        errorName: 'nb self update',
+    });
+    await run('nb', ['skills', 'update', '--yes'], {
+        stdio: 'inherit',
+        env: {
+            [NB_SKIP_STARTUP_UPDATE_ENV]: '1',
+        },
+        errorName: 'nb skills update',
+    });
+}
+export async function maybeRunStartupUpdatePrompt(argv) {
+    if (!(await shouldRunStartupUpdateCheck(argv))) {
+        return { kind: 'skipped' };
+    }
+    const selfStatus = await inspectSelfStatus();
+    if (!shouldEnableStartupUpdateForInstallMethod(selfStatus.installMethod)) {
+        return { kind: 'skipped' };
+    }
+    const skillsStatus = await inspectSkillsStatus();
+    if (!hasPendingUpdates(selfStatus, skillsStatus)) {
+        await markChecked();
+        return { kind: 'no-update' };
+    }
+    if (!isInteractiveTerminal()) {
+        printWarning(buildNonInteractiveWarning(selfStatus, skillsStatus));
+        await markChecked();
+        return { kind: 'warned' };
+    }
+    const answer = await p.confirm({
+        message: buildPromptMessage(selfStatus, skillsStatus),
+        active: 'Yes',
+        inactive: 'No',
+        initialValue: true,
+    });
+    if (p.isCancel(answer) || !answer) {
+        printWarning(buildDeclinedWarning(selfStatus, skillsStatus));
+        await markChecked();
+        return { kind: 'declined' };
+    }
+    await runStartupUpdates();
+    await markChecked();
+    return { kind: 'updated' };
+}

package/dist/locale/en-US.json

@@ -73,6 +73,8 @@
         },
         "scope": {
           "message": "Where should this connection be saved?",
+          "autoLabel": "Auto",
+          "autoHint": "project if this repo already has .nocobase, otherwise global",
           "projectLabel": "Project",
           "projectHint": ".nocobase in this repo",
           "globalLabel": "Global",
@@ -268,7 +270,7 @@
     },
     "init": {
       "validation": {
-        "envExists": "Env \"{{envName}}\" already exists in this workspace. Choose another env name."
+        "envExists": "Env \"{{envName}}\" already exists. Choose another env name."
       },
       "messages": {
         "title": "Set Up Your NocoBase AI Workspace",
@@ -276,6 +278,7 @@
         "appNameEnvHelp": "Use `nb init --yes --env <envName>` to continue.",
         "resumeEnvRequired": "Env name is required when resuming setup.",
         "resumeEnvHelp": "Use `nb init --resume --env <envName>` to continue.",
+        "resumeAfterInstallFailure": "Resume this setup with:\n  {{command}}",
         "uiOpening": "A local setup form will open in your browser. That form needs a person to fill it in. If you are using an AI agent, do not stop this process while the CLI waits for the submission.",
         "uiReady": "Local setup form is ready.",
         "uiReadyHelp": "If your browser does not open automatically, copy the URL below into your browser to continue. Keep this terminal session running while the CLI waits for the submission.",

package/dist/locale/zh-CN.json

@@ -73,6 +73,8 @@
         },
         "scope": {
           "message": "这个连接要保存到哪里？",
+          "autoLabel": "自动",
+          "autoHint": "当前仓库已有 .nocobase 时保存到项目内，否则保存到全局",
           "projectLabel": "项目内",
           "projectHint": "保存在当前仓库的 .nocobase 中",
           "globalLabel": "全局",
@@ -268,7 +270,7 @@
     },
     "init": {
       "validation": {
-        "envExists": "Env \"{{envName}}\" 已存在于当前 workspace 中，请换一个 env name。"
+        "envExists": "Env \"{{envName}}\" 已存在，请换一个 env name。"
       },
       "messages": {
         "title": "初始化你的 NocoBase AI 工作区",
@@ -276,6 +278,7 @@
         "appNameEnvHelp": "请使用 `nb init --yes --env <envName>` 继续。",
         "resumeEnvRequired": "恢复安装时必须提供 Env name。",
         "resumeEnvHelp": "请使用 `nb init --resume --env <envName>` 继续。",
+        "resumeAfterInstallFailure": "继续这次初始化请执行：\n  {{command}}",
         "uiOpening": "本地 setup 表单即将在浏览器中打开。这个表单需要等待人工填写。如果你正在使用 AI agent，请不要停止当前进程，CLI 会继续等待表单提交结果。",
         "uiReady": "本地 setup 表单已就绪。",
         "uiReadyHelp": "如果没有自动打开浏览器，请复制下面的地址到浏览器中继续。CLI 会继续等待表单提交，请保持当前终端会话继续运行。",

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-alpha.24",
+  "version": "2.1.0-alpha.26",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
   "scripts": {
     "clean": "node ./scripts/clean.mjs",
     "build": "node ./scripts/build.mjs",
-    "test": "TEST_ENV=server-side yarn --cwd ../../.. vitest run packages/core/cli"
+    "test": "NB_CLI_ROOT=. TEST_ENV=server-side yarn --cwd ../../.. vitest run packages/core/cli"
   },
   "keywords": [],
   "author": "",
@@ -36,8 +36,27 @@
     "dirname": "nb",
     "topicSeparator": " ",
     "topics": {
+      "app": {
+        "description": "Manage NocoBase app runtimes: start, stop, restart, logs, and upgrades."
+      },
+      "source": {
+        "description": "Work with the local NocoBase source project: download, develop, build, and test."
+      },
+      "scaffold": {
+        "description": "Generate NocoBase plugin development scaffolds."
+      },
+      "plugin": {
+        "description": "Manage plugins in the selected NocoBase env."
+      },
+      "pm": {
+        "description": "Manage plugins in the selected NocoBase env.",
+        "hidden": true
+      },
+      "db": {
+        "description": "Manage the built-in database for the selected env."
+      },
       "env": {
-        "description": "Manage NocoBase project environments and update command runtimes."
+        "description": "Manage NocoBase project environments, status, details, and command runtimes."
       },
       "self": {
         "description": "Inspect or update the NocoBase CLI itself."
@@ -45,6 +64,10 @@
       "skills": {
         "description": "Inspect or synchronize NocoBase AI coding skills for the current workspace."
       },
+      "examples": {
+        "description": "Internal example commands for prompt and UI experiments.",
+        "hidden": true
+      },
       "api": {
         "description": "Work with NocoBase API."
       }
@@ -68,5 +91,5 @@
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "effaf56a9b9ea2d40200c4c10854a84d9622f071"
+  "gitHead": "e6e6518030175b58080218bb4357642398bcb54a"
 }

package/dist/commands/ps.js

@@ -1,116 +0,0 @@
-/**
- * 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 { buildDockerDbContainerName, dockerContainerExists, dockerContainerIsRunning, formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, } from '../lib/app-runtime.js';
-import { listEnvs } from '../lib/auth-store.js';
-import { renderTable } from '../lib/ui.js';
-function appUrl(runtime) {
-    const port = String(runtime.env.config.appPort ?? '').trim();
-    if (port) {
-        return `http://127.0.0.1:${port}`;
-    }
-    const baseUrl = String(runtime.env.config.baseUrl ?? '').trim();
-    return baseUrl.replace(/\/api\/?$/, '');
-}
-async function isLocalAppHealthy(runtime) {
-    const port = String(runtime.env.config.appPort ?? '').trim();
-    if (!port) {
-        return false;
-    }
-    const controller = new AbortController();
-    const timeout = setTimeout(() => controller.abort(), 1500);
-    try {
-        const response = await fetch(`http://127.0.0.1:${port}/api/__health_check`, {
-            signal: controller.signal,
-        });
-        const text = await response.text();
-        return response.ok && text.trim().toLowerCase() === 'ok';
-    }
-    catch (_error) {
-        return false;
-    }
-    finally {
-        clearTimeout(timeout);
-    }
-}
-async function dockerStatus(containerName) {
-    if (!(await dockerContainerExists(containerName))) {
-        return 'missing';
-    }
-    return await dockerContainerIsRunning(containerName) ? 'running' : 'stopped';
-}
-async function dbStatus(runtime) {
-    if (!runtime.env.config.builtinDb) {
-        return runtime.kind === 'remote' ? 'external' : '-';
-    }
-    if (runtime.kind === 'remote') {
-        return 'external';
-    }
-    const dbDialect = String(runtime.env.config.dbDialect ?? 'postgres').trim() || 'postgres';
-    const containerName = buildDockerDbContainerName(runtime.envName, dbDialect, runtime.workspaceName);
-    return await dockerStatus(containerName);
-}
-async function appStatus(runtime) {
-    if (runtime.kind === 'remote') {
-        return 'remote';
-    }
-    if (runtime.kind === 'docker') {
-        return await dockerStatus(runtime.containerName);
-    }
-    return await isLocalAppHealthy(runtime) ? 'running' : 'stopped';
-}
-function sourceLabel(runtime) {
-    if (runtime.kind === 'remote') {
-        return 'remote';
-    }
-    return runtime.source;
-}
-export default class Ps extends Command {
-    static description = 'Show NocoBase runtime status for configured envs without starting or stopping anything.';
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> --env app1',
-    ];
-    static flags = {
-        env: Flags.string({
-            char: 'e',
-            description: 'CLI env name to inspect. Omit to show all configured envs',
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(Ps);
-        const requestedEnv = flags.env?.trim() || undefined;
-        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.');
-            return;
-        }
-        const rows = [];
-        for (const envName of envNames) {
-            const runtime = await resolveManagedAppRuntime(envName);
-            if (!runtime) {
-                if (requestedEnv) {
-                    this.error(formatMissingManagedAppEnvMessage(envName));
-                }
-                rows.push([envName, '-', 'missing', '-', '']);
-                continue;
-            }
-            rows.push([
-                runtime.envName,
-                sourceLabel(runtime),
-                await appStatus(runtime),
-                await dbStatus(runtime),
-                appUrl(runtime),
-            ]);
-        }
-        this.log(renderTable(['Env', 'Source', 'App', 'Database', 'URL'], rows));
-    }
-}