@nocobase/cli 2.1.0-beta.22 → 2.1.0-beta.23

package/README.md

@@ -115,7 +115,7 @@ nb init --env app1 --resume
 
 `--resume` reuses the saved workspace env config for app, source, database, and env connection settings. In interactive mode, it only asks for any missing setup-only values.
 
-In non-interactive mode, pass these setup-only flags again because they are not saved in env config:
+In non-interactive resume mode, `nb init --resume --yes` uses default initialization values unless these flags are passed explicitly:
 
 - `--lang`
 - `--root-username`
@@ -128,7 +128,7 @@ In non-interactive mode, pass these setup-only flags again because they are not
 | Command | Description |
 | --- | --- |
 | `nb init` | Set up NocoBase and connect it as a CLI env for coding agents. |
-| `nb app` | Manage app runtimes: start, stop, restart, logs, status, cleanup, and upgrades. |
+| `nb app` | Manage app runtimes: start, stop, restart, logs, cleanup, and upgrades. |
 | `nb source` | Manage the local source project: download, develop, build, and test. |
 | `nb db` | Inspect or manage built-in database runtime status for local envs. |
 | `nb env` | Manage saved CLI env connections. |
@@ -137,13 +137,13 @@ In non-interactive mode, pass these setup-only flags again because they are not
 | `nb self` | Check or update the installed NocoBase CLI. |
 | `nb skills` | Check, install, or update global NocoBase AI coding skills. |
 
-Recommended style: use `--env` explicitly for app/runtime commands. `-e` is the short form:
+Recommended style: pass the env name explicitly when operating on a specific env. Runtime commands accept `--env`, and `nb env info` also accepts a positional env name:
 
 ```bash
 nb app start --env app1
 nb app restart --env app1
 nb app logs --env app1
-nb app ps --env app1
+nb env info app1
 nb db ps --env app1
 ```
 
@@ -291,12 +291,18 @@ Show the current env:
 nb env
 ```
 
-List configured envs:
+List configured envs with token-verified API status:
 
 ```bash
 nb env list
 ```
 
+Show details for one env:
+
+```bash
+nb env info app1
+```
+
 Switch the current env:
 
 ```bash

package/README.zh-CN.md

@@ -110,7 +110,7 @@ nb init --env app1 --resume
 
 `--resume` 会复用工作区里已保存的 env config，包括应用、source、数据库和 env 连接相关配置。在交互模式下，只会继续补齐缺失的初始化参数。
 
-在非交互模式下，需要重新传这些只用于初始化、不会保存到 env config 的参数：
+在非交互恢复模式下，如果没有显式传入这些参数，`nb init --resume --yes` 会使用默认初始化值：
 
 - `--lang`
 - `--root-username`
@@ -130,13 +130,13 @@ nb init --env app1 --resume
 | `nb api` | 通过 CLI 调用 NocoBase API 资源。 |
 | `nb plugin` | 管理选中 NocoBase env 的插件。 |
 
-推荐在应用和运行时相关命令里显式使用 `--env`；`-e` 是它的简写：
+推荐在操作指定 env 时显式传入 env 名称。运行时命令支持 `--env`，`nb env info` 也支持位置参数：
 
 ```bash
 nb app start --env app1
 nb app restart --env app1
 nb app logs --env app1
-nb app ps --env app1
+nb env info app1
 nb db ps --env app1
 ```
 
@@ -252,12 +252,18 @@ nb app down --env app1 --all --yes
 nb env
 ```
 
-查看已配置的 env：
+查看已配置的 env 及 Token 验证后的 API 状态：
 
 ```bash
 nb env list
 ```
 
+查看某个 env 的详情：
+
+```bash
+nb env info app1
+```
+
 切换当前 env：
 
 ```bash

package/dist/commands/{app → env}/info.js

@@ -6,7 +6,7 @@
  * 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 { Args, Command, Flags } from '@oclif/core';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime } from '../../lib/app-runtime.js';
 import { renderTable } from '../../lib/ui.js';
 import { appRootPath, dbStatus, runtimeStatus, storagePath } from './shared.js';
@@ -42,14 +42,21 @@ function createGroupTable(title, values) {
 function serializeGroup(values) {
     return Object.fromEntries(Object.entries(values).map(([field, value]) => [field, normalizeJsonValue(value)]));
 }
-export default class AppInfo extends Command {
+export default class EnvInfo extends Command {
     static hidden = false;
-    static description = 'Show grouped details for the selected NocoBase app env, including app, database, API, and auth settings.';
+    static description = 'Show grouped details for the selected NocoBase env, including app, database, API, and auth settings.';
     static examples = [
+        '<%= config.bin %> <%= command.id %> app1',
+        '<%= config.bin %> <%= command.id %> app1 --json',
+        '<%= config.bin %> <%= command.id %> app1 --show-secrets',
         '<%= config.bin %> <%= command.id %> --env app1',
-        '<%= config.bin %> <%= command.id %> --env app1 --json',
-        '<%= config.bin %> <%= command.id %> --env app1 --show-secrets',
     ];
+    static args = {
+        name: Args.string({
+            description: 'CLI env name to inspect. Defaults to the current env when omitted',
+            required: false,
+        }),
+    };
     static flags = {
         env: Flags.string({
             char: 'e',
@@ -65,8 +72,13 @@ export default class AppInfo extends Command {
         }),
     };
     async run() {
-        const { flags } = await this.parse(AppInfo);
-        const requestedEnv = flags.env?.trim() || undefined;
+        const { args, flags } = await this.parse(EnvInfo);
+        const envNameArg = args.name?.trim() || undefined;
+        const envNameFlag = flags.env?.trim() || undefined;
+        if (envNameArg && envNameFlag && envNameArg !== envNameFlag) {
+            this.error(`Environment name was provided both as the argument ("${envNameArg}") and as --env ("${envNameFlag}"). Please use only one.`);
+        }
+        const requestedEnv = envNameArg || envNameFlag;
         const showSecrets = flags['show-secrets'];
         const runtime = await resolveManagedAppRuntime(requestedEnv);
         if (!runtime) {

package/dist/commands/env/list.js

@@ -7,30 +7,44 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Command } from '@oclif/core';
+import { resolveManagedAppRuntime } from '../../lib/app-runtime.js';
 import { listEnvs } from '../../lib/auth-store.js';
 import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
 import { renderTable } from '../../lib/ui.js';
-function resolveApiBaseUrl(config) {
-    return String(config.apiBaseUrl ?? config.baseUrl ?? config.apibaseUrl ?? '').trim();
-}
+import { apiStatus, appUrl, resolveApiBaseUrl } from './shared.js';
 export default class EnvList extends Command {
-    static summary = 'List configured environments';
+    static summary = 'List configured environments and API auth status';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
     ];
     async run() {
         await this.parse(EnvList);
-        const { currentEnv, envs } = await listEnvs({ scope: resolveDefaultConfigScope() });
+        const scope = resolveDefaultConfigScope();
+        const { currentEnv, envs } = await listEnvs({ scope });
         const names = Object.keys(envs).sort();
         if (!names.length) {
             this.log('No envs configured.');
             this.log('Run `nb env add <name> --api-base-url <url>` to add one.');
             return;
         }
-        const rows = names.map((name) => {
+        const rows = [];
+        for (const name of names) {
             const env = envs[name];
-            return [name === currentEnv ? '*' : '', name, resolveApiBaseUrl(env), env.auth?.type ?? '', env.runtime?.version ?? ''];
-        });
-        this.log(renderTable(['Current', 'Name', 'Base URL', 'Auth', 'Runtime'], rows));
+            const runtime = await resolveManagedAppRuntime(name);
+            const statusConfig = {
+                ...env,
+                ...(runtime?.env.config ?? {}),
+            };
+            rows.push([
+                name === currentEnv ? '*' : '',
+                name,
+                runtime?.kind ?? env.kind ?? '-',
+                await apiStatus(name, statusConfig, { scope }),
+                runtime ? appUrl(runtime) : resolveApiBaseUrl(env),
+                env.auth?.type ?? '',
+                env.runtime?.version ?? '',
+            ]);
+        }
+        this.log(renderTable(['Current', 'Name', 'Kind', 'App Status', 'URL', 'Auth', 'Runtime'], rows));
     }
 }

package/dist/commands/{app → env}/shared.js

@@ -6,7 +6,8 @@
  * 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 { buildDockerDbContainerName, dockerContainerExists, dockerContainerIsRunning, defaultWorkspaceName, } from '../../lib/app-runtime.js';
+import { buildDockerDbContainerName, dockerContainerExists, dockerContainerIsRunning, } from '../../lib/app-runtime.js';
+import { executeRawApiRequest } from '../../lib/api-client.js';
 export function resolveApiBaseUrl(config) {
     return String(config.apiBaseUrl ?? config.baseUrl ?? config.apibaseUrl ?? '').trim();
 }
@@ -18,12 +19,6 @@ export function appUrl(runtime) {
     const baseUrl = resolveApiBaseUrl(runtime.env.config);
     return baseUrl.replace(/\/api\/?$/, '');
 }
-export function appNetwork(runtime) {
-    if (runtime.kind === 'docker') {
-        return runtime.workspaceName?.trim() || defaultWorkspaceName();
-    }
-    return '-';
-}
 export function appRootPath(runtime) {
     if (runtime.kind === 'http' || runtime.kind === 'docker') {
         return '-';
@@ -40,6 +35,74 @@ export function storagePath(runtime) {
     const value = String(runtime.env.storagePath ?? runtime.env.config.storagePath ?? '').trim();
     return value || '-';
 }
+function collectErrorCodes(value) {
+    if (!value || typeof value !== 'object') {
+        return [];
+    }
+    if (Array.isArray(value)) {
+        return value.flatMap((item) => collectErrorCodes(item));
+    }
+    const out = [];
+    const record = value;
+    if (typeof record.code === 'string') {
+        out.push(record.code);
+    }
+    for (const key of ['data', 'error', 'errors']) {
+        out.push(...collectErrorCodes(record[key]));
+    }
+    return out;
+}
+function isAuthFailureData(value) {
+    const codes = collectErrorCodes(value);
+    return codes.some((code) => ['EMPTY_TOKEN', 'INVALID_TOKEN', 'EXPIRED_TOKEN', 'BLOCKED_TOKEN', 'EXPIRED_SESSION', 'NOT_EXIST_USER'].includes(code));
+}
+function isNetworkFailure(error) {
+    if (!(error instanceof Error)) {
+        return false;
+    }
+    return (error.name === 'AbortError'
+        || /fetch failed|network|timeout|timed out|abort|ECONNREFUSED|ECONNRESET|ENOTFOUND|ETIMEDOUT|EAI_AGAIN|ENETUNREACH/i.test(error.message));
+}
+function isUnconfiguredFailure(error) {
+    return error instanceof Error && /missing (a )?base url|missing base URL/i.test(error.message);
+}
+function isAuthFailure(error) {
+    return (error instanceof Error
+        && /EMPTY_TOKEN|INVALID_TOKEN|EXPIRED_TOKEN|BLOCKED_TOKEN|EXPIRED_SESSION|NOT_EXIST_USER|invalid_grant|sign in|signin|authentication failed/i.test(error.message));
+}
+export async function apiStatus(envName, config, options = {}) {
+    if (!resolveApiBaseUrl(config)) {
+        return 'unconfigured';
+    }
+    try {
+        const response = await executeRawApiRequest({
+            envName,
+            scope: options.scope,
+            method: 'GET',
+            path: '/auth:check',
+            timeoutMs: options.timeoutMs ?? 2000,
+        });
+        if (response.ok) {
+            return 'ok';
+        }
+        if (response.status === 401 || response.status === 403 || isAuthFailureData(response.data)) {
+            return 'auth failed';
+        }
+        return 'error';
+    }
+    catch (error) {
+        if (isUnconfiguredFailure(error)) {
+            return 'unconfigured';
+        }
+        if (isAuthFailure(error)) {
+            return 'auth failed';
+        }
+        if (isNetworkFailure(error)) {
+            return 'unreachable';
+        }
+        return 'error';
+    }
+}
 async function isLocalAppHealthy(runtime) {
     const port = String(runtime.env.config.appPort ?? '').trim();
     if (!port) {

package/dist/commands/init.js

@@ -139,6 +139,12 @@ function logInitUiReady(command, url) {
 function logInitUiBrowserOpenFallback() {
     p.log.warn(translateCli('commands.init.messages.uiOpenBrowserFallback'));
 }
+function formatBrowserOpenError(error) {
+    if (error instanceof Error) {
+        return error.message;
+    }
+    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.
@@ -405,8 +411,9 @@ Prompt modes:
                 onServerStart: ({ url }) => {
                     logInitUiReady(this, url);
                 },
-                onOpenBrowserError: (_url, _err) => {
+                onOpenBrowserError: (_url, err) => {
                     logInitUiBrowserOpenFallback();
+                    p.log.info(`Browser open error: ${formatBrowserOpenError(err)}`);
                 },
             });
         }

package/dist/lib/api-client.js

@@ -235,10 +235,24 @@ export async function executeRawApiRequest(options) {
         }
         url.searchParams.set(key, typeof value === 'object' ? JSON.stringify(value) : String(value));
     }
-    const response = await fetchWithPreservedAuthRedirect(url.toString(), {
-        method: options.method.toUpperCase(),
-        headers,
-        body: options.body === undefined ? undefined : JSON.stringify(options.body),
-    });
-    return parseResponse(response);
+    const controller = options.timeoutMs && options.timeoutMs > 0 ? new AbortController() : undefined;
+    const timeout = controller
+        ? setTimeout(() => {
+            controller.abort();
+        }, options.timeoutMs)
+        : undefined;
+    try {
+        const response = await fetchWithPreservedAuthRedirect(url.toString(), {
+            method: options.method.toUpperCase(),
+            headers,
+            body: options.body === undefined ? undefined : JSON.stringify(options.body),
+            signal: controller?.signal,
+        });
+        return parseResponse(response);
+    }
+    finally {
+        if (timeout) {
+            clearTimeout(timeout);
+        }
+    }
 }

package/dist/lib/prompt-web-ui.js

@@ -559,17 +559,23 @@ function readFormFromClientStrippingPwcMeta(o) {
     const { [PWC_FORM_META_STEP]: _meta, ...rest } = o;
     return rest;
 }
-function openUrlInDefaultBrowser(url) {
+function openUrlInDefaultBrowser(url, onError) {
+    const reportError = (error) => {
+        onError?.(url, error);
+    };
     const platform = process.platform;
+    let child;
     if (platform === 'darwin') {
-        spawn('open', [url], { stdio: 'ignore', detached: true }).unref();
+        child = spawn('open', [url], { stdio: 'ignore', detached: true });
     }
     else if (platform === 'win32') {
-        spawn('cmd', ['/c', 'start', '', url], { stdio: 'ignore', detached: true, windowsHide: true }).unref();
+        child = spawn('cmd', ['/c', 'start', '', url], { stdio: 'ignore', detached: true, windowsHide: true });
     }
     else {
-        spawn('xdg-open', [url], { stdio: 'ignore', detached: true }).unref();
+        child = spawn('xdg-open', [url], { stdio: 'ignore', detached: true });
     }
+    child.once('error', reportError);
+    child.unref();
 }
 function closePromptWebUiServer(server, done) {
     server.close(done);
@@ -2084,11 +2090,12 @@ function runPromptCatalogWebUIImpl(options) {
             const port = addr.port;
             const startUrl = `http://${host}:${port}/`;
             options.onServerStart?.({ host, port, url: startUrl });
+            const onOpenBrowserError = options.onOpenBrowserError ?? ((u, err) => console.warn(String(err), u));
             try {
-                openUrlInDefaultBrowser(startUrl);
+                openUrlInDefaultBrowser(startUrl, onOpenBrowserError);
             }
             catch (e) {
-                (options.onOpenBrowserError ?? ((u, err) => console.warn(String(err), u)))(startUrl, e);
+                onOpenBrowserError(startUrl, e);
             }
             timeoutId = setTimeout(() => rejectAndClose(new Error('Local UI timeout — close the tab and try again, or resubmit within the time limit.')), timeoutMs);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-beta.22",
+  "version": "2.1.0-beta.23",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -37,7 +37,7 @@
     "topicSeparator": " ",
     "topics": {
       "app": {
-        "description": "Manage NocoBase app runtimes: start, stop, restart, logs, status, and upgrades."
+        "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."
@@ -56,7 +56,7 @@
         "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."
@@ -91,5 +91,5 @@
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "53ad02861ed8e813103f59659804417118c85b4c"
+  "gitHead": "bb4c0d3551bf9eff505b63756dd24a0813231f16"
 }

package/dist/commands/app/ps.js

@@ -1,60 +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 { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, } from '../../lib/app-runtime.js';
-import { listEnvs } from '../../lib/auth-store.js';
-import { renderTable } from '../../lib/ui.js';
-import { appNetwork, appRootPath, appUrl, dbStatus, runtimeStatus, storagePath } from './shared.js';
-export default class AppPs extends Command {
-    static hidden = false;
-    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(AppPs);
-        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),
-                appNetwork(runtime),
-                appRootPath(runtime),
-                storagePath(runtime),
-                appUrl(runtime),
-            ]);
-        }
-        this.log(renderTable(['Env', 'Kind', 'App Status', 'Database Status', 'Network', 'App Root', 'Storage', 'URL'], rows));
-    }
-}

package/dist/commands/ps.js

@@ -1,12 +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 AppPs from './app/ps.js';
-export default class Ps extends AppPs {
-    static hidden = true;
-}