NocoBase CLI

NocoBase CLI combines:

• built-in commands for environment management and generic resource access
• runtime-generated commands loaded from your NocoBase application's Swagger schema

This allows the CLI to stay aligned with the target application instead of relying on a fixed command list.

Install

Install dependencies for local development:

pnpm install

Run in development mode:

node ./bin/dev.js --help

Build the CLI:

pnpm build

Run the built CLI:

node ./bin/run.js --help

After packaging or linking, the executable name is:

nocobase

Quick Start

Add an environment:

nocobase env add --name local --base-url http://localhost:13000/api --token <token>

Show the current environment:

nocobase env

List configured environments:

nocobase env list

Switch the current environment:

nocobase env use local

Update the runtime command cache from swagger:get:

nocobase env update
nocobase env update -e local

Use the generic resource commands:

nocobase resource list --resource users
nocobase resource get --resource users --filter-by-tk 1
nocobase resource create --resource users --values '{"nickname":"Ada"}'

Runtime Commands

When you execute a runtime command, the CLI will:

1. resolve the target environment
2. read the application's Swagger schema from swagger:get
3. generate or reuse a cached runtime command set for that application version
4. execute the requested command

If the API documentation plugin is disabled, the CLI will prompt to enable it.

Environment Selection

Use -e, --env to temporarily select an environment:

nocobase env update -e prod
nocobase resource list --resource users -e prod

This does not change the current environment unless you explicitly run:

nocobase env use <name>

Config Scope

The env command supports two config scopes:

• project: use ./.nocobase-cli in the current working directory
• global: use the global .nocobase-cli directory

Use -s, --scope to select one explicitly:

nocobase env list -s project
nocobase env add -s global --name prod --base-url http://example.com/api --token <token>
nocobase env use local -s project

If you do not pass --scope, the CLI uses automatic resolution:

1. current working directory if ./.nocobase-cli exists
2. NOCOBASE_HOME_CLI
3. your home directory

Built-in Commands

Current built-in topics:

• env
• resource

Check available commands at any time:

nocobase --help
nocobase env --help
nocobase resource --help

Common Flags

• -e, --env: temporary environment selection
• -s, --scope: config scope for env commands
• -t, --token: token override
• -j, --json-output: print raw JSON response

Example:

nocobase env update -e prod -s global
nocobase resource list --resource users -e prod -j

Local Data

The CLI stores its local state in .nocobase-cli, including:

• config.json: environment definitions and current selection
• versions/<version>/commands.json: cached runtime commands for a generated version