Nocobase API

https://docs.nocobase.com/api
Admin
Nocobase is an open-source no-code development platform that allows users to build custom business...
Tokens:137,791
Snippets:1,626
Trust Score:8.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### nb session setup examples

Source: https://docs.nocobase.com/api/cli/session/setup

Examples of running the setup command. The first uses the detected shell, the others specify a target shell with --shell.

```bash
nb session setup
```

```bash
nb session setup --shell zsh
```

```bash
nb session setup --shell powershell
```

--------------------------------

### nb db start examples

Source: https://docs.nocobase.com/api/cli/db/start

Examples of starting the built-in database: with default env, with a specific env, and with verbose output.

```bash
nb db start
```

```bash
nb db start --env app1
```

```bash
nb db start --env app1 --verbose
```

--------------------------------

### Generate and start Nginx and Caddy examples

Source: https://docs.nocobase.com/api/cli/proxy

Provides two complete examples: one for generating and starting Nginx with the docker driver, and one for generating and starting Caddy with the local driver. Both target the env named demo and use the host demo.local.nocobase.com.

```bash
# Generate and start Nginx for one env
nb proxy nginx use docker
nb proxy nginx generate --env demo --host demo.local.nocobase.com
nb proxy nginx start

# Generate and start Caddy for one env
nb proxy caddy use local
nb proxy caddy generate --env demo --host demo.local.nocobase.com
nb proxy caddy start
```

--------------------------------

### nb app start examples

Source: https://docs.nocobase.com/api/cli/app/start

Examples of starting the app with different flags: default environment, explicit env, verbose output, and Docker env.

```bash
nb app start
```

```bash
nb app start --env local
```

```bash
nb app start --env local --verbose
```

```bash
nb app start --env local-docker
```

--------------------------------

### Continue prepared env flow

Source: https://docs.nocobase.com/api/cli/init

Continues a prepared env flow: activate the license, then start the app. nb app start completes the first installation and switches the env from prepared to normal installed state.

```bash
nb license activate --env app1
```

```bash
nb app start --env app1
```

--------------------------------

### Prepare, activate license, and start app

Source: https://docs.nocobase.com/api/cli/init

Prepares the app configuration without installing, then activates the license and starts the app later. The --prepare-only flag only saves the env config and copies the hook file; it does not execute hooks.

```bash
nb init --env app1 --prepare-only
nb license activate --env app1
nb app start --env app1
```

--------------------------------

### nb app subcommand examples

Source: https://docs.nocobase.com/api/cli/app

Provides examples of using the nb app subcommands to manage the application runtime, including start, restart, autostart, logs, upgrade, and stop.

```bash
nb app start --env app1
nb app restart --env app1
nb app autostart enable --env app1 --yes
nb app autostart run
nb app logs --env app1
nb app upgrade --env app1 --skip-download
nb app stop --env app1 --with-db
```

--------------------------------

### nb skills install examples

Source: https://docs.nocobase.com/api/cli/skills/install

Example invocations of nb skills install. The --yes flag skips installation confirmation, --verbose shows detailed installation output, and --json outputs JSON.

```bash
nb skills install
```

```bash
nb skills install --yes
```

```bash
nb skills install --verbose
```

```bash
nb skills install --json
```

--------------------------------

### nb env example commands

Source: https://docs.nocobase.com/api/cli/env

Example commands for adding, viewing, listing, checking status, getting info, updating, switching, and authenticating a saved env.

```bash
nb env add app1 --api-base-url http://localhost:13000/api
nb env current
nb env list
nb env status
nb env info app1
nb env update app1
nb env use app1
nb env auth app1
```

--------------------------------

### Examples of nb config get commands

Source: https://docs.nocobase.com/api/cli/config/get

Examples of retrieving various configuration items, including locale, update policy, license package URL, Docker settings, image registry and variant, proxy settings, and binary paths.

```bash
nb config get locale
nb config get update.policy
nb config get license.pkg-url
nb config get docker.network
nb config get docker.container-prefix
nb config get nb-image-registry
nb config get nb-image-variant
nb config get proxy.nb-cli-root
nb config get proxy.upstream-host
nb config get proxy.nginx-driver
nb config get proxy.caddy-driver
nb config get bin.nginx
nb config get bin.git
```

--------------------------------

### nb api resource examples

Source: https://docs.nocobase.com/api/cli/api

Examples of using `nb api resource` commands to list, get, create, and list resources with various options.

```bash
nb api resource list --resource users -e app1
nb api resource get --resource users --filter-by-tk 1 -e app1
nb api resource create --resource users --values '{"nickname":"Ada"}' -e app1
nb api resource list --resource users -e app1 --no-json-output
```

--------------------------------

### Examples: get user and associated comment

Source: https://docs.nocobase.com/api/cli/api/resource/get

Two examples: get a user with primary key 1, and get a comment with source-id 1 and primary key 2.

```bash
nb api resource get --resource users --filter-by-tk 1
```

```bash
nb api resource get --resource posts.comments --source-id 1 --filter-by-tk 2
```

--------------------------------

### nb portal config examples

Source: https://docs.nocobase.com/api/cli/portal/config

Examples of configuring a portal. Each command updates the portal configuration with the specified flags.

```bash
nb portal config customer --path ./portals/customer
nb portal config customer --source-storage nocobase
nb portal config customer --source-storage git --git-repo git@github.com:nocobase/customer-portal.git
nb portal config customer --git-branch main --git-path portals/customer
```

--------------------------------

### Start development mode

Source: https://docs.nocobase.com/api/cli/portal

Starts development mode for the specified portal in the development environment.

```bash
nb portal dev customer -e dev --yes
```

--------------------------------

### Examples: nb portal deploy

Source: https://docs.nocobase.com/api/cli/portal/deploy

Two example invocations: one deploying the 'customer' portal with the current env, and another deploying it with the 'dev' env and skipping confirmation.

```bash
nb portal deploy customer
```

```bash
nb portal deploy customer --env dev --yes
```

--------------------------------

### start(): void

Source: https://docs.nocobase.com/api/telemetry/metric

Starts the metric reader.

```APIDOC
## start(): void

### Description
Starts the `MetricReader`.

### Signature
`start(): void`
```

--------------------------------

### nb license activate examples

Source: https://docs.nocobase.com/api/cli/license/activate

Examples of activating a license: without arguments, with a direct key, with a key file, and with JSON output.

```bash
nb license activate
```

```bash
nb license activate --env app1 --key <licenseKey>
```

```bash
nb license activate --env app1 --key-file ./license.txt
```

```bash
nb license activate --env app1 --json --key-file ./license.txt
```

--------------------------------

### nb config subcommand examples

Source: https://docs.nocobase.com/api/cli/config

Examples of using nb config subcommands to list, get, set, and delete configuration keys. Shows how to override update policy, proxy settings, image registry and variant, and executable paths.

```bash
nb config list
nb config get update.policy
nb config set update.policy auto
nb config get proxy.nb-cli-root
nb config set proxy.nb-cli-root /workspace
nb config set proxy.upstream-host host.docker.internal
nb config set proxy.nginx-driver docker
nb config set proxy.caddy-driver local
nb config get docker.network
nb config set docker.network nocobase
nb config get nb-image-registry
nb config set nb-image-registry aliyun
nb config set nb-image-variant full-no-nginx
nb config set bin.nginx /usr/sbin/nginx
nb config set bin.git /usr/bin/git
nb config set bin.pnpm /usr/local/bin/pnpm
nb config delete docker.container-prefix
```

--------------------------------

### nb api resource command examples

Source: https://docs.nocobase.com/api/cli/api/resource

Examples of using nb api resource subcommands: list, get, create, and list with association resource and fields.

```bash
nb api resource list --resource users
nb api resource get --resource users --filter-by-tk 1
nb api resource create --resource users --values '{"nickname":"Ada"}'
nb api resource list --resource posts.comments --source-id 1 --fields id --fields content
```

--------------------------------

### Quick install with basic auth and custom admin

Source: https://docs.nocobase.com/api/cli/init

Quickly installs a local app in non-interactive mode with basic authentication and a custom admin account.

```bash
nb init --env app1 --yes \
  --auth-type basic \
  --root-username admin \
  --root-password secret123
```

--------------------------------

### Install app non-interactively with nb init --yes

Source: https://docs.nocobase.com/api/cli/init

Installs a new local app in non-interactive mode. If --source is omitted, Docker is usually used as the install source. The examples show how to specify the source (docker, npm, or git) and version (latest, beta, alpha, or a specific branch).

```bash
nb init --env app1 --yes
nb init --env app1 --yes --source docker --version latest
nb init --env app1 --yes --source docker --version beta
nb init --env app1 --yes --source docker --version alpha
nb init --env app1 --yes --source docker --version main \
  --docker-registry registry.cn-beijing.aliyuncs.com/nocobase/nocobase
nb init --env app1 --yes --source npm --version latest
nb init --env app1 --yes --source npm --version beta
nb init --env app1 --yes --source npm --version alpha
nb init --env app1 --yes --source npm --version beta --app-port 13080
nb init --env app1 --yes --source git --version latest
nb init --env app1 --yes --source git --version beta
nb init --env app1 --yes --source git --version alpha
nb init --env app1 --yes --source git --version feat/plugin-workflow-timeout
nb init --env app1 --yes --source git --version latest \
  --git-url https://gitee.com/nocobase/nocobase.git
```

--------------------------------

### nb api resource list examples

Source: https://docs.nocobase.com/api/cli/api/resource/list

Three examples demonstrating basic listing, querying association resources with source-id and field selection, and filtering with sorting.

```bash
nb api resource list --resource users
```

```bash
nb api resource list --resource posts.comments --source-id 1 --fields id --fields content
```

```bash
nb api resource list --resource users --filter '{"status":"active"}' --sort=-createdAt
```

--------------------------------

### appVersion usage examples

Source: https://docs.nocobase.com/api/server/migration

Examples of setting the 'appVersion' property. The framework uses semver.satisfies() to evaluate the range.

```ts
// Only executes when upgrading from a version below 1.0.0
appVersion = '<1.0.0';

// Only executes when upgrading from a version below 0.21.0-alpha.13
appVersion = '<0.21.0-alpha.13';

// Leave empty to execute on every upgrade
appVersion = '';
```

--------------------------------

### start()

Source: https://docs.nocobase.com/api/telemetry/telemetry

Starts the processing of telemetry data, enabling export to backends like Prometheus.

```APIDOC
## start()

### Description
Starts the processing of Trace and Metric related data, such as exporting to Prometheus.

### Method
start

### Signature
start(): void

### Parameters
None.

### Response
No return value.
```

--------------------------------

### nb env add examples

Source: https://docs.nocobase.com/api/cli/env/add

Examples of adding an environment with various options: interactive prompt, named environment, OAuth authentication, and token authentication with an access token.

```bash
nb env add
```

```bash
nb env add local
```

```bash
nb env add local --api-base-url http://localhost:13000/api --auth-type oauth
```

```bash
nb env add local --api-base-url http://localhost:13000/api --auth-type token --access-token <token>
```

--------------------------------

### nb plugin import examples

Source: https://docs.nocobase.com/api/cli/plugin/import

Examples of importing from remote archive, local archive, npm package, private registry, and with storage path override.

```bash
# Remote archive
nb plugin import https://github.com/nocobase/plugin-auth-cas/releases/download/v1.4.0/plugin-auth-cas-1.4.0.tgz
```

```bash
# Local archive
nb plugin import /your/path/plugin-auth-cas-1.4.0.tgz
```

```bash
# npm package or tag
nb plugin import @my-scope/plugin-auth-cas@beta
```

```bash
# Private npm registry
nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.example.com
```

```bash
# Write directly into a local storage path without relying on the current env
nb plugin import ./plugin-auth-cas-1.4.0.tgz --storage-path ./storage
```

--------------------------------

### nb source examples

Source: https://docs.nocobase.com/api/cli/source

Example commands for the nb source subcommands: download, dev, build, and test.

```bash
nb source download --source npm --version alpha
nb source download --source docker --version alpha --docker-platform auto
nb source dev --env app1
nb source build @nocobase/acl
nb source test --server --coverage
```

--------------------------------

### nb app start usage

Source: https://docs.nocobase.com/api/cli/app/start

Shows the general syntax for the nb app start command, which starts the NocoBase app for a selected environment.

```bash
nb app start [flags]
```

--------------------------------

### Start Nginx proxy with nb proxy nginx start

Source: https://docs.nocobase.com/api/cli/proxy/nginx/start

Starts the Nginx proxy using the current driver. With the local driver, it starts the local Nginx process; with the docker driver, it starts or creates the Docker container. If the proxy is already running, the command reports that it is already running.

```bash
nb proxy nginx start
```

--------------------------------

### Start dev mode for a portal in the current env

Source: https://docs.nocobase.com/api/cli/portal/dev

Starts development mode for the portal named 'customer' in the current environment.

```bash
nb portal dev customer
```

--------------------------------

### create() example

Source: https://docs.nocobase.com/api/database/relation-repository/has-one-repository

Example of using create() to create an associated object. The output shows the created profile with its id, avatar, userId, and timestamps.

```typescript
const profile = await UserProfileRepository.create({
  values: { avatar: 'avatar1' },
});

console.log(profile.toJSON());
/*
{
  id: 1,
  avatar: 'avatar1',
  userId: 1,
  updatedAt: 2022-09-24T13:59:40.025Z,
  createdAt: 2022-09-24T13:59:40.025Z
}
*/
```

--------------------------------

### nb plugin command examples

Source: https://docs.nocobase.com/api/cli/plugin

Examples of importing a plugin archive, listing plugins, enabling a plugin, and disabling a plugin with the nb plugin command.

```bash
nb plugin import ./plugin-auth-cas-1.4.0.tgz --storage-path ./storage
nb plugin list -e local
nb plugin enable @nocobase/plugin-sample
nb plugin disable -e local @nocobase/plugin-sample
```

--------------------------------

### nb env auth examples

Source: https://docs.nocobase.com/api/cli/env/auth

Examples of authenticating the current env, a specific env, using OAuth, basic authentication, and token authentication.

```bash
# Authenticate the current env with the saved authentication method
nb env auth
```

```bash
# Authenticate a specific env
nb env auth prod
```

```bash
# Use OAuth browser login
nb env auth prod --auth-type oauth
```

```bash
# Sign in with username and password
nb env auth prod --auth-type basic --username admin --password secret
```

```bash
# Save an API key or access token
nb env auth prod --auth-type token --access-token <api-key>
```

--------------------------------

### nb app upgrade examples

Source: https://docs.nocobase.com/api/cli/app/upgrade

Common usage examples for the `nb app upgrade` command, including force, env, skip-download, version, and verbose flags.

```bash
nb app upgrade
```

```bash
nb app upgrade --force
```

```bash
nb app upgrade --env local
```

```bash
nb app upgrade --env local --force
```

```bash
nb app upgrade --env local --skip-download
```

```bash
nb app upgrade --env local --skip-download --version beta
```

```bash
nb app upgrade --env local --version beta
```

```bash
nb app upgrade --env local --verbose
```

```bash
nb app upgrade --env local-docker --skip-download
```

--------------------------------

### Start dev mode for a portal in a specified env

Source: https://docs.nocobase.com/api/cli/portal/dev

Starts development mode for the portal named 'customer' in the 'dev' environment, skipping the interactive confirmation with --yes.

```bash
nb portal dev customer --env dev --yes
```

--------------------------------

### nb backup create examples

Source: https://docs.nocobase.com/api/cli/backup/create

Five example invocations covering default behavior, custom output paths, env selection with confirmation skip, and JSON output.

```bash
nb backup create
```

```bash
nb backup create --output ./backups
```

```bash
nb backup create --output ./backups/base.nbdata
```

```bash
nb backup create --env e2e --output ./backups --yes
```

```bash
nb backup create --env e2e --json-output
```

--------------------------------

### Open browser wizard with nb init --ui

Source: https://docs.nocobase.com/api/cli/init

Opens the local browser-based setup wizard. The second command specifies a custom port for the wizard UI.

```bash
nb init --ui
nb init --ui --ui-port 3000
```

--------------------------------

### Enable autostart examples

Source: https://docs.nocobase.com/api/cli/app/autostart/enable

Examples of enabling autostart for the current environment, for a specific environment, and for a specific environment without confirmation. The --yes flag is required in non-interactive terminals when the target env differs from the current env.

```bash
nb app autostart enable
```

```bash
nb app autostart enable --env app1
```

```bash
nb app autostart enable --env app1 --yes
```

--------------------------------

### Get field configuration value with field.get()

Source: https://docs.nocobase.com/api/database/field

Retrieves the value of a field's configuration item using the get() method. The example shows getting the 'name' configuration item from a field, which returns 'name'.

```ts
const field = db.collection('users').getField('name');

// Get the value of the field name configuration item, returns 'name'
console.log(field.get('name'));
```

--------------------------------

### nb backup create and restore examples

Source: https://docs.nocobase.com/api/cli/backup

Examples of creating and restoring backups. The create commands download the backup locally, and the restore command uploads a local backup file to the target env.

```bash
nb backup create
```

```bash
nb backup create --env app1 --output ./backups
```

```bash
nb backup create --env app1 --output ./backups/result.nbdata
```

```bash
nb backup restore --env app1 --file ./backups/backup_20260520_190408_8397.nbdata --yes --force
```

--------------------------------

### nb backup restore examples

Source: https://docs.nocobase.com/api/cli/backup/restore

Two examples: one restoring to the current environment with `--force`, and one restoring to a specified environment with `--yes` and `--force`.

```bash
nb backup restore --file ./backups/base.nbdata --force
```

```bash
nb backup restore --env e2e --file ./backups/base.nbdata --yes --force
```

--------------------------------

### nb portal pull examples

Source: https://docs.nocobase.com/api/cli/portal/pull

Example invocations of nb portal pull covering default, env override, custom path, temporary Git source, force re-pull, and skipping install.

```bash
nb portal pull customer
```

```bash
nb portal pull customer --env prod --yes
```

```bash
nb portal pull customer --path ./portals/customer
```

```bash
nb portal pull customer --git-repo git@github.com:nocobase/customer-portal.git --git-branch main --git-path portals/customer
```

```bash
nb portal pull customer --force
```

```bash
nb portal pull customer --no-install
```

--------------------------------

### Examples: nb app autostart commands

Source: https://docs.nocobase.com/api/cli/app/autostart

Examples of the nb app autostart subcommands. Enable autostart for the current or a specific env, list autostart status, run all enabled envs, and show verbose output with --verbose.

```bash
# Enable autostart for the current env
nb app autostart enable

# Enable autostart for a specific env
nb app autostart enable --env app1 --yes

# Show autostart status
nb app autostart list

# Start every enabled env
nb app autostart run

# Show underlying startup output
nb app autostart run --verbose
```

--------------------------------

### nb skills examples

Source: https://docs.nocobase.com/api/cli/skills

Example commands for checking, installing, updating, and removing NocoBase AI coding skills. The --yes flag skips confirmation prompts, and --json outputs results in JSON format.

```bash
nb skills check
nb skills install --yes
nb skills update --json
nb skills remove --yes
```

--------------------------------

### getModel() example

Source: https://docs.nocobase.com/api/database

Gets a model class by name. If a custom model was registered, the returned class inherits from it, but is not strictly equal to it.

```javascript
db.registerModels({
  books: class MyModel extends Model {},
});

const ModelClass = db.getModel('books');

console.log(ModelClass.prototype instanceof MyModel); // true
```

--------------------------------

### nb source dev usage examples

Source: https://docs.nocobase.com/api/cli/source/dev

Examples of using nb source dev with various flags. The --env flag selects the CLI environment; --db-sync syncs the database before starting; --port sets the development server port; --client and --server start only the client or server; --inspect sets the Node.js inspect debug port for the server.

```bash
nb source dev
```

```bash
nb source dev --env app1
```

```bash
nb source dev --env app1 --db-sync
```

```bash
nb source dev --env app1 --port 12000
```

```bash
nb source dev --env app1 --client
```

```bash
nb source dev --env app1 --server
```

```bash
nb source dev --env app1 --inspect 9229
```

--------------------------------

### Initialize app interactively with nb init

Source: https://docs.nocobase.com/api/cli/init

Initializes a new NocoBase app interactively in the terminal, guiding you through the setup step by step.

```bash
nb init
```

--------------------------------

### Examples: nb db ps and nb db ps --env app1

Source: https://docs.nocobase.com/api/cli/db/ps

Two example invocations: one without flags to show all envs, and one with `--env app1` to inspect a specific environment.

```bash
nb db ps
```

```bash
nb db ps --env app1
```

--------------------------------

### nb self update usage examples

Source: https://docs.nocobase.com/api/cli/self/update

Example invocations of nb self update. The first runs with defaults, the second skips confirmation, the third also refreshes globally installed AI coding skills, and the last updates to the alpha channel with JSON output.

```bash
nb self update
```

```bash
nb self update --yes
```

```bash
nb self update --skills
```

```bash
nb self update --channel alpha --json
```

--------------------------------

### Push source and deploy

Source: https://docs.nocobase.com/api/cli/portal

Pushes local source changes to source storage and then builds and deploys the portal.

```bash
nb portal push customer -e dev --yes --message "Update customer portal"
nb portal deploy customer -e dev --yes
```

--------------------------------

### getRepository() example

Source: https://docs.nocobase.com/api/database

Gets a repository for a collection and for an associated collection with a relation ID. The second parameter sets the foreign key value for relational data.

```javascript
const AuthorsRepo = db.getRepository('authors');
const author1 = AuthorsRepo.create({ name: 'author1' });

const PostsRepo = db.getRepository('authors.posts', author1.id);
const post1 = AuthorsRepo.create({ title: 'post1' });
asset(post1.authorId === author1.id); // true
```

--------------------------------

### Run autostart with verbose output

Source: https://docs.nocobase.com/api/cli/app/autostart/run

Shows raw startup output from the underlying local or Docker command. The --verbose flag is forwarded to the underlying startup flow.

```bash
nb app autostart run --verbose
```

--------------------------------

### nb config set examples

Source: https://docs.nocobase.com/api/cli/config/set

Example commands that set various configuration keys, including locale, update policy, license URL, Docker settings, image registry and variant, binary paths, proxy settings, and package manager. The value cannot be empty.

```bash
nb config set locale zh-CN
nb config set update.policy auto
nb config set license.pkg-url https://pkg.nocobase.com/
nb config set docker.network nocobase
nb config set docker.container-prefix nb
nb config set nb-image-registry dockerhub
nb config set nb-image-registry aliyun
nb config set nb-image-variant full
nb config set nb-image-variant full-no-nginx
nb config set bin.docker /usr/local/bin/docker
nb config set bin.caddy /opt/homebrew/bin/caddy
nb config set bin.git /usr/bin/git
nb config set bin.nginx /usr/sbin/nginx
nb config set bin.pnpm /usr/local/bin/pnpm
nb config set proxy.nb-cli-root /workspace
nb config set proxy.upstream-host host.docker.internal
nb config set proxy.nginx-driver docker
nb config set proxy.caddy-driver local
nb config set bin.yarn yarn
```

--------------------------------

### GET nb api resource get

Source: https://docs.nocobase.com/api/cli/api/resource/get

Get one record from a selected resource. Usually, `--filter-by-tk` is used to specify the primary key.

```APIDOC
## [GET] nb api resource get

### Description
Get one record from a selected resource. Usually, `--filter-by-tk` is used to specify the primary key.

### Method
GET

### Endpoint
`nb api resource get --resource <resource> [flags]`

### Parameters
#### Path Parameters
- **resource** (string) - Required - Resource name

#### Query Parameters
- **data-source** (string) - Optional - Data source key, default `main`
- **source-id** (string) - Optional - Source record ID for association resources
- **filter-by-tk** (string) - Optional - Primary key value; composite or multiple keys can be passed as a JSON array
- **fields** (string[]) - Optional - Fields to query; repeatable or pass a JSON array
- **appends** (string[]) - Optional - Association fields to append; repeatable or pass a JSON array
- **except** (string[]) - Optional - Fields to exclude; repeatable or pass a JSON array

### Request Example
```bash
nb api resource get --resource users --filter-by-tk 1
nb api resource get --resource posts.comments --source-id 1 --filter-by-tk 2
```

### Response
#### Success Response (200)
Returns the requested record.

#### Response Example
No response example provided.

```

--------------------------------

### Run autostart for all enabled envs

Source: https://docs.nocobase.com/api/cli/app/autostart/run

Starts every env that has app autostart enabled. If no env has autostart enabled, prints 'No environments have app autostart enabled.'.

```bash
nb app autostart run
```

--------------------------------

### Start Caddy proxy

Source: https://docs.nocobase.com/api/cli/proxy/caddy/start

Starts the Caddy proxy using the current driver. With the local driver, it starts the local Caddy process; with the docker driver, it starts or creates the Docker container. If the proxy is already running, the command reports that it is already running.

```bash
nb proxy caddy start
```

--------------------------------

### afterDefineCollection event example

Source: https://docs.nocobase.com/api/database

Example of registering an afterDefineCollection event listener.

```javascript
db.on('afterDefineCollection', (collection) => {
  // do something
});
```

--------------------------------

### nb plugin list examples

Source: https://docs.nocobase.com/api/cli/plugin/list

Examples of listing plugins for the current environment, a local environment, and a local-docker environment. The `--yes` flag skips the confirmation prompt when the target env differs from the current one.

```bash
nb plugin list
```

```bash
nb plugin list -e local
```

```bash
nb plugin list -e local --yes
```

```bash
nb plugin list -e local-docker
```

--------------------------------

### beforeDefineCollection event example

Source: https://docs.nocobase.com/api/database

Example of registering a beforeDefineCollection event listener.

```javascript
db.on('beforeDefineCollection', (options) => {
  // do something
});
```

--------------------------------

### Examples: nb license plugins sync

Source: https://docs.nocobase.com/api/cli/license/plugins/sync

Common usage examples for the sync command, including options like --env, --yes, --dry-run, --skip-if-no-license, and --json.

```bash
nb license plugins sync
```

```bash
nb license plugins sync --env app1
```

```bash
nb license plugins sync --env app1 --yes
```

```bash
nb license plugins sync --env app1 --dry-run
```

```bash
nb license plugins sync --env app1 --skip-if-no-license
```

```bash
nb license plugins sync --env app1 --json
```

--------------------------------

### Resync environment status after start

Source: https://docs.nocobase.com/api/cli

Resyncs environment status after starting the application.

```bash
nb app start -e app1
nb env update app1
```

--------------------------------

### nb source download examples

Source: https://docs.nocobase.com/api/cli/source/download

Example invocations of nb source download covering npm, Docker, and Git sources with various flags such as --yes, --no-build, --output-dir, --docker-registry, --docker-platform, --docker-save, --git-url, --build-dts, --npm-registry, and --hook-script.

```bash
nb source download
```

```bash
nb source download -y --source npm --version alpha
```

```bash
nb source download -y --source npm --version alpha --no-build
```

```bash
nb source download --source npm --version alpha --output-dir=./app
```

```bash
nb source download --source docker --version alpha --docker-registry=nocobase/nocobase --docker-platform=linux/arm64
```

```bash
nb source download -y --source docker --version alpha --docker-save -o ./docker-images
```

```bash
nb source download --source git --version alpha --git-url=git@github.com:nocobase/nocobase.git
```

```bash
nb source download --source git --version fix/cli-v2
```

```bash
nb source download -y --source npm --version alpha --build-dts
```

```bash
nb source download -y --source npm --version alpha --npm-registry=https://registry.npmmirror.com
```

```bash
nb source download -y --source git --version beta --hook-script ./hooks.mjs
```

--------------------------------

### nb skills remove examples

Source: https://docs.nocobase.com/api/cli/skills/remove

Examples of removing skills with and without flags.

```bash
nb skills remove
```

```bash
nb skills remove --yes
```

```bash
nb skills remove --json
```

--------------------------------

### nb portal info examples

Source: https://docs.nocobase.com/api/cli/portal/info

Examples of the nb portal info command. The first shows basic usage, the second specifies the dev environment and skips cross-env confirmation, and the third prints portal details as JSON.

```bash
nb portal info customer
```

```bash
nb portal info customer --env dev --yes
```

```bash
nb portal info customer --json
```

--------------------------------

### init(): void

Source: https://docs.nocobase.com/api/telemetry/metric

Initializes the metric provider.

```APIDOC
## init(): void

### Description
Initializes the `MetricProvider`.

### Signature
`init(): void`
```

--------------------------------

### Prepare env without installing app

Source: https://docs.nocobase.com/api/cli/init

Prepares an env without installing the app yet. Available for local installation flows, including the --ui wizard, but not for remote connection flows.

```bash
nb init --env app1 --prepare-only
```

```bash
nb init --env app1 --prepare-only --ui
```

```bash
nb init --env app1 --prepare-only --yes
```

--------------------------------

### nb api resource create examples

Source: https://docs.nocobase.com/api/cli/api/resource/create

Three example invocations: creating a single record, creating multiple records with a JSON array, and creating an associated record using --source-id.

```bash
nb api resource create --resource users --values '{"nickname":"Ada"}'
```

```bash
nb api resource create --resource users --values '[{"nickname":"Ada"},{"nickname":"Grace"}]'
```

```bash
nb api resource create --resource posts.comments --source-id 1 --values '{"content":"Hello"}'
```

--------------------------------

### set() example

Source: https://docs.nocobase.com/api/database/relation-repository/has-one-repository

Example of using set() to set the associated object by its target key.

```typescript
const newProfile = await Profile.repository.create({
  values: { avatar: 'avatar2' },
});

await UserProfileRepository.set(newProfile.get('id'));

(await UserProfileRepository.find()).get('id') === newProfile.get('id'); // true
```

--------------------------------

### update() example

Source: https://docs.nocobase.com/api/database/relation-repository/has-one-repository

Example of using update() to update the associated object's values.

```typescript
const profile = await UserProfileRepository.update({
  values: { avatar: 'avatar2' },
});

profile.get('avatar'); // 'avatar2'
```

--------------------------------

### $notStatsWith - Check if string does not start with substring

Source: https://docs.nocobase.com/api/database/operators

Filters records where the title field does not start with the substring 'Classic'.

```TypeScript
repository.find({
  filter: {
    title: {
      $notStatsWith: 'Classic',
    },
  },
});
```

--------------------------------

### nb db start usage

Source: https://docs.nocobase.com/api/cli/db/start

Shows the command syntax for starting the built-in database container. Use `--env` to specify the CLI env, and `--verbose` to show underlying Docker command output.

```bash
nb db start [flags]
```

--------------------------------

### $startsWith - Check if string starts with substring

Source: https://docs.nocobase.com/api/database/operators

Filters records where the title field starts with the substring 'Classic'.

```TypeScript
repository.find({
  filter: {
    title: {
      $startsWith: 'Classic',
    },
  },
});
```

--------------------------------

### nb scaffold plugin and migration examples

Source: https://docs.nocobase.com/api/cli/scaffold

Examples of generating a plugin scaffold and a migration script. The plugin command takes a package name, and the migration command takes a migration name and the --pkg option to specify the plugin package.

```bash
nb scaffold plugin @nocobase-example/plugin-hello
nb scaffold migration migration-name --pkg @nocobase/plugin-acl
```

--------------------------------

### nb self examples

Source: https://docs.nocobase.com/api/cli/self

Examples of using nb self to check the current version and update the CLI.

```bash
nb self check
```

```bash
nb self check --json
```

```bash
nb self update --yes
```

--------------------------------

### afterSaveWithAssociations event example

Source: https://docs.nocobase.com/api/database

Example of registering afterSaveWithAssociations event listeners. The second listener is scoped to the 'books' collection.

```javascript
db.on('afterSaveWithAssociations', async (model, options) => {
  // do something
});

db.on('books.afterSaveWithAssociations', async (model, options) => {
  // do something
});
```

--------------------------------

### afterUpdateWithAssociations event example

Source: https://docs.nocobase.com/api/database

Example of registering afterUpdateWithAssociations event listeners. The second listener is scoped to the 'books' collection.

```javascript
db.on('afterUpdateWithAssociations', async (model, options) => {
  // do something
});

db.on('books.afterUpdateWithAssociations', async (model, options) => {
  // do something
});
```
Tokens:
Raw