Back to Nocobase

nb self check

docs/docs/en/api/cli/self/check.md

2.1.171.4 KB
Original Source

nb self check

Check the current NocoBase CLI installation, resolve the latest version for the selected channel, and report whether self-update is supported.

Usage

bash
nb self check [flags]

Parameters

ParameterTypeDescription
--channelstringRelease channel to compare with, default auto; options: auto, latest, test, beta, alpha
--jsonbooleanOutput JSON

Install Method

nb self check detects the current install method at runtime. It does not use the historical self-install-methods.json cache.

The command can report these install methods:

Install methodMeaning
npm-globalThe CLI is installed under the current npm prefix -g.
pnpm-globalThe CLI is installed under a pnpm global node_modules tree.
yarn-globalThe CLI is launched from yarn global bin or installed under yarn global dir.
package-localThe CLI is installed in a local project dependency tree.
sourceThe CLI is running from a repository checkout.
unknownThe CLI install could not be matched to a supported install method.

Self-update is supported for npm-global, pnpm-global, and yarn-global. For package-local or source, update the parent project or repository checkout instead.

Examples

bash
nb self check
nb self check --channel beta
nb self check --json