@nocobase/cli 2.1.0-alpha.25 → 2.1.0-alpha.27

package/dist/lib/startup-update.js

@@ -8,8 +8,9 @@
  */
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import * as p from '@clack/prompts';
-import { inspectSelfStatus, } from './self-manager.js';
+import { inspectSelfInstall, inspectSelfStatus, } from './self-manager.js';
 import { inspectSkillsStatus } from './skills-manager.js';
 import { resolveCliHomeDir } from './cli-home.js';
 import { isInteractiveTerminal, printWarning } from './ui.js';
@@ -19,8 +20,37 @@ const NB_SKIP_STARTUP_UPDATE_ENV = 'NB_SKIP_STARTUP_UPDATE';
 function getStateFile() {
     return path.join(resolveCliHomeDir('global'), STARTUP_UPDATE_STATE_FILE);
 }
+function getCurrentInstallBinPath() {
+    return path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..', '..', 'bin', 'run.js');
+}
+function getCurrentInstallEntry(state) {
+    return state.entries?.[getCurrentInstallBinPath()];
+}
 function todayStamp(now = new Date()) {
-    return now.toISOString().slice(0, 10);
+    const timeZone = String(process.env.TZ ?? '').trim();
+    if (timeZone) {
+        try {
+            const parts = new Intl.DateTimeFormat('en-CA', {
+                timeZone,
+                year: 'numeric',
+                month: '2-digit',
+                day: '2-digit',
+            }).formatToParts(now);
+            const year = parts.find((part) => part.type === 'year')?.value;
+            const month = parts.find((part) => part.type === 'month')?.value;
+            const day = parts.find((part) => part.type === 'day')?.value;
+            if (year && month && day) {
+                return `${year}-${month}-${day}`;
+            }
+        }
+        catch {
+            // Fall back to the host local timezone.
+        }
+    }
+    const year = now.getFullYear();
+    const month = String(now.getMonth() + 1).padStart(2, '0');
+    const day = String(now.getDate()).padStart(2, '0');
+    return `${year}-${month}-${day}`;
 }
 function shouldSkipByArgv(argv) {
     const tokens = argv.filter((token) => token && !token.startsWith('-'));
@@ -46,8 +76,46 @@ async function writeState(state) {
     await fs.mkdir(path.dirname(filePath), { recursive: true });
     await fs.writeFile(filePath, JSON.stringify(state, null, 2));
 }
+function readCurrentInstallLastCheckedDate(state) {
+    return getCurrentInstallEntry(state)?.lastCheckedDate ?? state.lastCheckedDate;
+}
+async function writeCurrentInstallEntry(updater) {
+    const state = await readState();
+    const installBinPath = getCurrentInstallBinPath();
+    const nextEntry = updater(getCurrentInstallEntry(state), state);
+    await writeState({
+        ...state,
+        entries: {
+            ...(state.entries ?? {}),
+            [installBinPath]: nextEntry,
+        },
+    });
+}
 async function markChecked(now = new Date()) {
-    await writeState({ lastCheckedDate: todayStamp(now) });
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: current?.policy ?? 'daily',
+            lastCheckedDate: todayStamp(now),
+        };
+    });
+}
+async function disableStartupUpdateForCurrentInstall() {
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: 'disabled',
+            lastCheckedDate: current?.lastCheckedDate
+                ?? state.lastCheckedDate,
+        };
+    });
+}
+async function enableDailyStartupUpdateForCurrentInstall() {
+    await writeCurrentInstallEntry((current, state) => {
+        return {
+            policy: 'daily',
+            lastCheckedDate: current?.lastCheckedDate
+                ?? state.lastCheckedDate,
+        };
+    });
 }
 export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
     if (process.env[NB_SKIP_STARTUP_UPDATE_ENV] === '1') {
@@ -57,7 +125,20 @@ export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
         return false;
     }
     const state = await readState();
-    return state.lastCheckedDate !== todayStamp(now);
+    const currentEntry = getCurrentInstallEntry(state);
+    if (currentEntry?.policy === 'disabled') {
+        return false;
+    }
+    if (currentEntry?.policy === 'daily') {
+        return readCurrentInstallLastCheckedDate(state) !== todayStamp(now);
+    }
+    const selfInstall = await inspectSelfInstall();
+    if (!shouldEnableStartupUpdateForInstallMethod(selfInstall.installMethod)) {
+        await disableStartupUpdateForCurrentInstall();
+        return false;
+    }
+    await enableDailyStartupUpdateForCurrentInstall();
+    return readCurrentInstallLastCheckedDate(state) !== todayStamp(now);
 }
 export function shouldEnableStartupUpdateForInstallMethod(installMethod) {
     return installMethod === 'npm-global';
@@ -173,9 +254,6 @@ export async function maybeRunStartupUpdatePrompt(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();

package/dist/locale/en-US.json

@@ -62,6 +62,13 @@
       "allocateNotDockerPublished": "Failed to allocate an available TCP port that is not already published by Docker.",
       "alreadyInUse": "Port {{port}} is already in use. Choose another port.",
       "alreadyInUseByDocker": "Port {{port}} is already in use by a Docker container. Choose another port."
+    },
+    "dbConnection": {
+      "unreachable": "Can't reach the database at {{host}}:{{port}}. Check the host, port, and network connectivity. Details: {{details}}",
+      "timeout": "Timed out connecting to the database at {{host}}:{{port}} after about {{seconds}} seconds.",
+      "authenticationFailed": "Failed to sign in to database \"{{database}}\" with user \"{{user}}\". Check the username and password.",
+      "databaseNotFound": "Database \"{{database}}\" does not exist or is not accessible with the current connection settings.",
+      "connectionFailed": "Database connection check failed. Details: {{details}}"
     }
   },
   "commands": {
@@ -73,10 +80,6 @@
         },
         "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",
           "globalHint": "user-level config"
         },
@@ -273,7 +276,7 @@
         "envExists": "Env \"{{envName}}\" already exists. Choose another env name."
       },
       "messages": {
-        "title": "Set Up Your NocoBase AI Workspace",
+        "title": "Set Up NocoBase for Coding Agents",
         "appNameRequiredWhenSkipped": "Env name is required when prompts are skipped.",
         "appNameEnvHelp": "Use `nb init --yes --env <envName>` to continue.",
         "resumeEnvRequired": "Env name is required when resuming setup.",
@@ -303,24 +306,24 @@
         }
       },
       "webUi": {
-        "pageTitle": "Set Up Your NocoBase AI Workspace",
-        "documentHeading": "Set Up Your NocoBase AI Workspace",
-        "documentHint": "Connect an existing NocoBase app, or install a new one and connect it, so coding agents can work with NocoBase in this workspace.",
+        "pageTitle": "Set Up NocoBase for Coding Agents",
+        "documentHeading": "Set Up NocoBase for Coding Agents",
+        "documentHint": "Connect an existing NocoBase app, or install a new one, so coding agents can access and work with NocoBase.",
         "gettingStarted": {
           "title": "Getting started",
-          "description": "Pick your setup path."
+          "description": "Choose whether to connect an existing app or install a new one."
         },
         "connectExistingApp": {
           "title": "Connect an existing app",
-          "description": "Add your app connection."
+          "description": "Save your app connection."
         },
         "createNewApp": {
-          "title": "Create a new app",
-          "description": "Set project basics."
+          "title": "Install a new app",
+          "description": "Set app basics and install options."
         },
         "downloadAppFiles": {
           "title": "Download app files",
-          "description": "Choose source and options."
+          "description": "Choose how to get the app files."
         },
         "configureDatabase": {
           "title": "Configure the database",

package/dist/locale/zh-CN.json

@@ -62,6 +62,13 @@
       "allocateNotDockerPublished": "分配未被 Docker 占用的可用 TCP 端口失败。",
       "alreadyInUse": "端口 {{port}} 已被占用，请更换其他端口。",
       "alreadyInUseByDocker": "端口 {{port}} 已被 Docker 容器占用，请更换其他端口。"
+    },
+    "dbConnection": {
+      "unreachable": "无法连接到数据库 {{host}}:{{port}}。请检查主机、端口和网络连通性。详情：{{details}}",
+      "timeout": "连接数据库 {{host}}:{{port}} 超时，约 {{seconds}} 秒内未成功建立连接。",
+      "authenticationFailed": "无法使用用户 \"{{user}}\" 登录数据库 \"{{database}}\"。请检查用户名和密码。",
+      "databaseNotFound": "数据库 \"{{database}}\" 不存在，或当前连接配置无权访问该数据库。",
+      "connectionFailed": "数据库连接检查失败。详情：{{details}}"
     }
   },
   "commands": {
@@ -73,10 +80,6 @@
         },
         "scope": {
           "message": "这个连接要保存到哪里？",
-          "autoLabel": "自动",
-          "autoHint": "当前仓库已有 .nocobase 时保存到项目内，否则保存到全局",
-          "projectLabel": "项目内",
-          "projectHint": "保存在当前仓库的 .nocobase 中",
           "globalLabel": "全局",
           "globalHint": "保存在用户级配置中"
         },
@@ -273,7 +276,7 @@
         "envExists": "Env \"{{envName}}\" 已存在，请换一个 env name。"
       },
       "messages": {
-        "title": "初始化你的 NocoBase AI 工作区",
+        "title": "配置供 Coding Agents 使用的 NocoBase",
         "appNameRequiredWhenSkipped": "跳过 prompts 时必须提供 Env name。",
         "appNameEnvHelp": "请使用 `nb init --yes --env <envName>` 继续。",
         "resumeEnvRequired": "恢复安装时必须提供 Env name。",
@@ -303,24 +306,24 @@
         }
       },
       "webUi": {
-        "pageTitle": "初始化你的 NocoBase AI 工作区",
-        "documentHeading": "初始化你的 NocoBase AI 工作区",
-        "documentHint": "连接已有的 NocoBase 应用，或安装一个新的应用后再完成连接，让 Coding Agents 可以在当前工作区中结合 NocoBase 协同工作。",
+        "pageTitle": "配置供 Coding Agents 使用的 NocoBase",
+        "documentHeading": "配置供 Coding Agents 使用的 NocoBase",
+        "documentHint": "连接已有的 NocoBase 应用，或安装一个新的应用，让 Coding Agents 可以在当前工作区中访问和操作 NocoBase。",
         "gettingStarted": {
           "title": "开始设置",
-          "description": "选择你的配置路径。"
+          "description": "选择连接已有应用，或安装一个新应用。"
         },
         "connectExistingApp": {
           "title": "连接已有应用",
-          "description": "添加现有应用连接。"
+          "description": "保存现有应用连接。"
         },
         "createNewApp": {
-          "title": "创建新应用",
-          "description": "设置项目基础信息。"
+          "title": "安装新应用",
+          "description": "设置应用基础信息和安装选项。"
         },
         "downloadAppFiles": {
           "title": "下载应用文件",
-          "description": "选择来源和下载选项。"
+          "description": "选择获取应用文件的方式。"
         },
         "configureDatabase": {
           "title": "配置数据库",

package/nocobase-ctl.config.json

@@ -215,6 +215,88 @@
         }
       }
     },
+    "backup": {
+      "name": "backup",
+      "description": "Create, inspect, download, remove, and restore NocoBase backups.",
+      "include": true,
+      "resources": {
+        "includes": ["backup"],
+        "excludes": [],
+        "overrides": {
+          "backup": {
+            "name": "backup",
+            "description": "Manage backup and restore files.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "backup:list",
+                "backup:create",
+                "backup:status",
+                "backup:download",
+                "backup:remove",
+                "backup:restore",
+                "backup:restoreUpload",
+                "backup:restoreStatus"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "migration": {
+      "name": "migration",
+      "description": "Create, check, execute, and inspect migration packages.",
+      "include": true,
+      "resources": {
+        "includes": ["migration", "migrationLog", "migrationRule", "migrationRules"],
+        "excludes": [],
+        "overrides": {
+          "migration": {
+            "name": "migration",
+            "description": "Manage migration files and executions.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "migration:list",
+                "migration:get",
+                "migration:create",
+                "migration:download",
+                "migration:remove",
+                "migration:check",
+                "migration:execute"
+              ]
+            }
+          },
+          "migrationRule": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "Create migration rules with global user/system policies.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRule:create"]
+            }
+          },
+          "migrationRules": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "List and inspect migration rules.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRules:list", "migrationRules:get"]
+            }
+          },
+          "migrationLog": {
+            "name": "migration logs",
+            "segments": ["migration", "logs"],
+            "description": "List, inspect, and download migration logs.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationLog:list", "migrationLog:get", "migrationLog:download"]
+            }
+          }
+        }
+      }
+    },
     "system-settings": {
       "name": "system-settings",
       "description": "Adjust system title, logo, language, and other global settings.",

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-alpha.25",
+  "version": "2.1.0-alpha.27",
   "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,33 @@
     "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."
+      },
+      "license": {
+        "description": "Manage NocoBase commercial licensing and licensed plugins."
+      },
+      "config": {
+        "description": "Manage CLI configuration defaults."
       },
       "self": {
         "description": "Inspect or update the NocoBase CLI itself."
@@ -45,6 +70,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."
       }
@@ -52,21 +81,27 @@
   },
   "dependencies": {
     "@clack/prompts": "^0.9.1",
+    "@nocobase/license-kit": "^0.3.8",
     "@oclif/core": "^4.10.4",
     "cross-spawn": "^7.0.6",
     "lodash": "^4.17.21",
+    "mariadb": "^2.5.6",
+    "mysql2": "^3.14.0",
     "openapi-types": "^12.1.3",
     "ora": "^8.2.0",
-    "picocolors": "^1.1.1"
+    "pg": "^8.14.1",
+    "picocolors": "^1.1.1",
+    "tar": "^7.4.3"
   },
   "devDependencies": {
     "@types/node": "^18.19.130",
     "tsx": "^4.20.6",
-    "typescript": "^6.0.2"
+    "typescript": "^6.0.2",
+    "vitest": "^1.5.0"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "63e4aaa625f3108fe41238e85bb13dee37fe1f48"
+  "gitHead": "a340a88d86d3ff7e06d723215b02aa3c122f4870"
 }

package/dist/commands/ps.js

@@ -1,119 +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 resolveApiBaseUrl(config) {
-    return String(config.apiBaseUrl ?? config.baseUrl ?? config.apibaseUrl ?? '').trim();
-}
-function appUrl(runtime) {
-    const port = String(runtime.env.config.appPort ?? '').trim();
-    if (port) {
-        return `http://127.0.0.1:${port}`;
-    }
-    const baseUrl = resolveApiBaseUrl(runtime.env.config);
-    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 === 'http' ? 'external' : '-';
-    }
-    if (runtime.kind === 'http') {
-        return 'external';
-    }
-    if (runtime.kind === 'ssh') {
-        return '-';
-    }
-    const dbDialect = String(runtime.env.config.dbDialect ?? 'postgres').trim() || 'postgres';
-    const containerName = buildDockerDbContainerName(runtime.envName, dbDialect, runtime.workspaceName);
-    return await dockerStatus(containerName);
-}
-async function runtimeStatus(runtime) {
-    if (runtime.kind === 'http') {
-        return 'http';
-    }
-    if (runtime.kind === 'ssh') {
-        return 'ssh';
-    }
-    if (runtime.kind === 'docker') {
-        return await dockerStatus(runtime.containerName);
-    }
-    return await isLocalAppHealthy(runtime) ? 'running' : 'stopped';
-}
-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,
-                runtime.kind,
-                await runtimeStatus(runtime),
-                await dbStatus(runtime),
-                appUrl(runtime),
-            ]);
-        }
-        this.log(renderTable(['Env', 'Kind', 'Status', 'Database', 'URL'], rows));
-    }
-}