@nocobase/cli 2.1.0-alpha.2 → 2.1.0-alpha.20

package/LICENSE.txt

@@ -0,0 +1,107 @@
+Updated Date: February 24, 2026
+
+NocoBase License Agreement
+
+NOCOBASE PTE. LTD.，a Singaporean Exempt Private Company Limited by Shares with its principal place of business located at 112 ROBINSON ROAD, #03-01, SINGAPORE ("The Company") https://www.nocobase.com/ issues this License Agreement ("Agreement") to you. You, as an individual or a company ("The User"), will be deemed to voluntarily accept all terms of this Agreement by using NocoBase (including but not limited to obtaining NocoBase source code or installation package in any form, installing and using NocoBase, purchasing NocoBase commercial license and services, purchasing NocoBase commercial plugins). If the User does not agree to any term of this Agreement, or cannot accurately understand our interpretation of the relevant terms, please stop using it immediately.
+
+This Agreement applies to any use, quotation, contract, invoice, and all software delivered by the Company. The User and the Company or NocoBase's agents can no longer sign a separate license agreement for the sale and delivery of the software.
+
+The Company reserves the right to formulate and modify this Agreement from time to time as needed. If there are changes, the Company will announce them in the form of website announcements, without further individual notification. The changed Agreement will automatically take effect once it is announced, becoming part of this Agreement.
+
+==============
+1. Definitions
+==============
+
+1.1 "Software" refers to the NocoBase kernel and plugins placed in the same code repository as the kernel, including their source code, installation packages, images, and all their modifications, updates, and upgrades.
+
+1.2 "Community Edition" refers to the free version of the Software provided to the User through public channels.
+
+1.3 "Commercial Edition" refers to the paid version of the Software purchased by the User from the Company or its agents, downloaded through exclusive channels, and includes additional benefits. It consists of three versions: Standard Edition, Professional Edition, and Enterprise Edition.
+
+1.4 "Upper Layer Application" refers to a specific business use case application serving internal or external customers of the User, developed based on Software and Commercial Plugins, such as ERP/CRM.
+
+1.5 "Customer" refers to the clients who purchase the User's Upper Layer Application.
+
+1.6 "Third-Party Open Source Software" refers to open source software provided with Software and Commercial Plugins. They are licensed through various published open source software licenses or copyright notices accompanying such software.
+
+===================================
+2. Intellectual Property Protection
+===================================
+
+Except for Third-Party Open Source Software, the Company owns all copyrights, trademark rights, patent rights, trade secrets, and other intellectual property rights of the Software, and has registered and protected them in relevant countries and regions according to the "Paris Convention" or "TRIPS Agreement", ensuring that the intellectual property rights of the Software and Commercial Plugins are internationally recognized and protected.
+
+=============
+3. Disclaimer
+=============
+
+3.1 The User shall not use the Software and Commercial Plugins to engage in activities that contravene applicable laws and regulations or offend against public order or religious prohibitions. All legal liabilities and consequences arising from the User’s use shall be borne by the User.
+
+3.2 The Company shall not be liable for any direct, indirect, special, incidental, or consequential damages (including but not limited to loss of profits, business interruption, data loss, or business information disclosure) caused by the User's use of the Software and Commercial Plugins, even if it has been previously informed of the possibility of such damages.
+
+===============
+4. License Type
+===============
+
+4.1 This Agreement serves as the unified license agreement for NocoBase Software, applying to both the Community Edition and the Commercial Editions.
+
+4.2 This Agreement incorporates and references the full text of the Apache License, Version 2.0 ("Apache-2.0", available at: https://www.apache.org/licenses/LICENSE-2.0 ). Users must comply with the Apache-2.0 License as well as the supplementary terms set forth in this Agreement. In case of any inconsistency between Apache-2.0 and this Agreement, the supplementary terms of this Agreement shall prevail.
+
+================================================
+5. Rights and Obligations of Open Source License
+================================================
+
+5.1 The Software can be used for commercial purposes.
+
+5.2 It is not allowed to remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface, except for the main LOGO in the upper left corner of the page.
+
+5.3 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+5.4 It is not allowed to provide to the public any form of no-code, zero-code, low-code, AI platform SaaS/PaaS products using the original or modified Software.
+
+===============================
+6. Rights of Commercial License
+===============================
+
+6.1 Obtain a permanent commercial license of the Software.
+
+6.2 Get software upgrades and exclusive technical support during the upgrade validity period.
+
+6.3 The licensed Software can be used for commercial purposes with no restrictions on the number of applications and users.
+
+6.4 Can remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface.
+
+6.5 The User holding a Professional or Enterprise Edition License can sell Upper Layer Application to its Customers.
+
+6.6 If there are other agreements in the contract for the above rights, the contract agreement shall prevail.
+
+====================================
+7. Obligations of Commercial License
+====================================
+
+7.1 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+7.2 It is not allowed to sell, transfer, lease, share, gift, or distribute the Commercial License.
+
+7.3 It is not allowed to sell, transfer, lease, share, or distribute any form of no-code, zero-code, low-code, AI platform, or developer tools developed based on Software.
+
+7.4 It is not allowed to provide any form of no-code, zero-code, low-code, AI platform SaaS/PaaS products to the public using the original or modified Software.
+
+7.5 It is not allowed for the User holding a Standard Edition license to sell Upper Layer Application to Customers without a Commercial license.
+
+7.6 It is not allowed for the User holding a Professional or Enterprise Edition license to sell Upper Layer Application to Customers without a Commercial license with access to further development and configuration.
+
+7.7 If there is a violation of the above obligations or the terms of this Agreement, the rights owned by the User will be immediately terminated, the paid fees will not be refunded, and the Company reserves the right to pursue the User's legal responsibility.
+
+7.8 If there are other agreements in the contract for the above obligations, the contract agreement shall prevail.
+
+=============================================================
+8.  Legal Jurisdiction, Interpretation, and Dispute Resolution
+=============================================================
+
+8.1 Except for Mainland China, the interpretation, application, and all matters related to this agreement are subject to the jurisdiction of Singapore law.
+
+8.2 Any dispute related to this Agreement should first be resolved through friendly negotiation. If the negotiation fails to resolve the dispute, the dispute should be submitted to the International Chamber of Commerce (ICC) for arbitration. The arbitration venue should be Singapore, conducted in English.
+
+8.3 All terms and conditions of this Agreement shall be deemed enforceable to the maximum extent permitted by applicable law. If any term of this Agreement is deemed invalid by any applicable law, the invalidity of that term does not affect the validity of any other term of this Agreement, and it should be deemed that the invalid term has been modified as much as possible to make it valid and enforceable, or if the term cannot be modified, it should be deemed to have been deleted from this Agreement.
+
+8.4 The arbitration award is final, binding on both parties, and can be enforced in any court with jurisdiction.

package/README.md

@@ -1,30 +1,176 @@
-# NocoBase
+# NocoBase CTL
 
-<video width="100%" controls>
-      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
-</video>
+NocoBase CTL is a command-line tool for managing and controlling NocoBase applications. Its relationship with multiple NocoBase App instances is shown below:
 
+```
+                        +----------------------+
+                        |     NocoBase CTL     |
+                        |      Controller     |
+                        +----------------------+
+                                   |
+                  +----------------+----------------+
+                  |                |                |
+                  v                v                v
+        +----------------+ +----------------+ +----------------+
+        |  NocoBase App  | |  NocoBase App  | |  NocoBase App  |
+        |      Dev       | |      Test      | |      Prod      |
+        +----------------+ +----------------+ +----------------+
+```
 
-## What is NocoBase
+NocoBase CTL combines:
 
-NocoBase is a scalability-first, open-source no-code development platform.  
-Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
+- built-in commands for environment management and generic resource access
+- runtime-generated commands loaded from your NocoBase application's Swagger schema
 
-Homepage:  
-https://www.nocobase.com/
+This allows the CLI to stay aligned with the target application instead of relying on a fixed command list.
 
-Online Demo:  
-https://demo.nocobase.com/new
+## Quick Start
 
-Documents:  
-https://docs.nocobase.com/
+Install NocoBase CTL globally:
 
-Commericial license & plugins:  
-https://www.nocobase.com/en/commercial
+```bash
+npm install -g @nocobase/ctl@latest
+```
 
-License agreement:   
-https://www.nocobase.com/en/agreement
+Add an environment:
 
+```bash
+nb env add local --base-url http://localhost:13000/api
+```
 
-## Contact Us:  
-hello@nocobase.com
+Add an environment with an API key:
+
+```bash
+nb env add local --base-url http://localhost:13000/api --auth-type token --token <api-key>
+```
+
+Authenticate an environment with OAuth:
+
+```bash
+nb env auth local
+```
+
+Show the current environment:
+
+```bash
+nb env
+```
+
+List configured environments:
+
+```bash
+nb env list
+```
+
+Switch the current environment:
+
+```bash
+nb env use local
+```
+
+Update the runtime command cache from `swagger:get`:
+
+```bash
+nb env update
+nb env update local
+```
+
+Use the generic resource commands:
+
+```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"}'
+```
+
+## 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
+
+`nb env update` and `nb env auth` take an optional environment name as the first argument (omit it to use the current env):
+
+```bash
+nb env update prod
+nb env auth prod
+```
+
+Use `-e, --env` on **runtime / API** commands to temporarily select an environment:
+
+```bash
+nb api resource list --resource users -e prod
+```
+
+This does not change the current environment unless you explicitly run:
+
+```bash
+nb env use <name>
+```
+
+## Config Scope
+
+The `env` command supports two config scopes:
+
+- `project`: use `./.nocobase-ctl` in the current working directory
+- `global`: use the global `.nocobase-ctl` directory
+
+Use `-s, --scope` to select one explicitly:
+
+```bash
+nb env list -s project
+nb env add prod -s global --base-url http://example.com/api --auth-type token --token <api-key>
+nb env auth prod -s global
+nb env use local -s project
+```
+
+If you do not pass `--scope`, the CLI uses automatic resolution:
+
+1. current working directory if `./.nocobase-ctl` exists
+2. `NOCOBASE_HOME_CLI`
+3. your home directory
+
+## Built-in Commands
+
+Current built-in topics:
+
+- `env`
+- `api`
+
+Check available commands at any time:
+
+```bash
+nb --help
+nb env --help
+nb api resource --help
+```
+
+## Common Flags
+
+- `-e, --env`: temporary environment selection
+- `-s, --scope`: config scope for `env` commands
+- `--role`: role override, sent as `X-Role`
+- `-t, --token`: API key override
+- `-j, --json-output`: print raw JSON response
+
+Example:
+
+```bash
+nb env update prod -s global
+nb api resource list --resource users -e prod -j
+nb api resource list --resource users -e prod --role admin
+```
+
+## Local Data
+
+The CLI stores its local state in `.nocobase-ctl`, including:
+
+- `config.json`: environment definitions and current selection
+- `versions/<version>/commands.json`: cached runtime commands for a generated version

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const root = path.resolve(__dirname, '..');
+const realRoot = fs.realpathSync(root);
+const isSourcePackage = realRoot.split(path.sep).join('/').endsWith('/packages/core/cli');
+let isDev = isSourcePackage;
+if (process.env.NB_CLI_USE_DIST === '1') {
+  isDev = false;
+}
+
+/**
+ * In the monorepo, plain `node` cannot load `.ts`. Re-exec once with `--import tsx`
+ * (same effect as a dedicated dev entry with `#!/usr/bin/env -S node --import tsx`).
+ */
+function reexecWithTsx() {
+  const result = spawnSync(
+    process.execPath,
+    ['--import', 'tsx', '--disable-warning=ExperimentalWarning', ...process.argv.slice(1)],
+    {
+      stdio: 'inherit',
+      env: {
+        ...process.env,
+        _NOCO_CLI_TSX_CHILD: '1',
+        NODE_ENV: 'development',
+      },
+    },
+  );
+  process.exit(result.status === null ? 1 : result.status);
+}
+
+if (isDev && !process.env._NOCO_CLI_TSX_CHILD) {
+  reexecWithTsx();
+}
+
+const bootstrapPath = isDev ? path.join(root, 'src/lib/bootstrap.ts') : path.join(root, 'dist/lib/bootstrap.js');
+const { ensureRuntimeFromArgv } = await import(pathToFileURL(bootstrapPath).href);
+const { flush, run, settings } = await import('@oclif/core');
+
+if (isDev) {
+  settings.debug = true;
+}
+
+function getCommandToken(argv) {
+  const tokens = [];
+
+  for (const token of argv) {
+    if (!token || token.startsWith('-')) {
+      continue;
+    }
+
+    tokens.push(token);
+  }
+
+  if (tokens[0] === 'api') {
+    return tokens[1] ?? tokens[0];
+  }
+
+  return tokens[0];
+}
+
+function formatCliEntryError(error, argv) {
+  const message = error instanceof Error ? error.message : String(error);
+  const missingCommandMatch = message.match(/^Command (.+) not found\.$/);
+  if (missingCommandMatch) {
+    const commandToken = getCommandToken(argv) ?? missingCommandMatch[1];
+    return [
+      `Unknown command: \`${commandToken}\`.`,
+      'If this is a built-in command or a typo, run `nb --help` to inspect available commands.',
+      `If \`${commandToken}\` should be a runtime command from your NocoBase app, run \`nb env update\` and try again.`,
+    ].join('\n');
+  }
+
+  return message;
+}
+
+try {
+  const argv = process.argv.slice(2);
+  if (argv[0] === 'api') {
+    await ensureRuntimeFromArgv(argv, {
+      configFile: path.join(root, 'nocobase-ctl.config.json'),
+    });
+  }
+  await run(argv, import.meta.url);
+  flush();
+} catch (error) {
+  const message = formatCliEntryError(error, process.argv.slice(2));
+  console.error(message);
+  process.exitCode = 1;
+}

package/dist/commands/api/resource/create.js

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+import { buildCreateArgs, createFlags, runResourceCommand } from '../../../lib/resource-command.js';
+export default class ResourceCreate extends Command {
+    static summary = 'Create a record in a resource';
+    static description = 'Create a record in a generic resource. Pass record content through --values as a JSON object.';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --resource users --values '{"nickname":"Ada"}'`,
+        `<%= config.bin %> <%= command.id %> --resource posts.comments --source-id 1 --values '{"content":"Hello"}'`,
+    ];
+    static flags = createFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceCreate);
+        await runResourceCommand(this, 'create', flags, buildCreateArgs(flags));
+    }
+}

package/dist/commands/api/resource/destroy.js

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+import { buildDestroyArgs, destroyFlags, runResourceCommand } from '../../../lib/resource-command.js';
+export default class ResourceDestroy extends Command {
+    static summary = 'Delete records from a resource';
+    static description = 'Delete records from a generic resource. Target records with --filter-by-tk or --filter.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --resource users --filter-by-tk 1',
+        `<%= config.bin %> <%= command.id %> --resource posts --filter '{"status":"archived"}'`,
+    ];
+    static flags = destroyFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceDestroy);
+        await runResourceCommand(this, 'destroy', flags, buildDestroyArgs(flags));
+    }
+}

package/dist/commands/api/resource/get.js

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+import { buildGetArgs, getFlags, runResourceCommand } from '../../../lib/resource-command.js';
+export default class ResourceGet extends Command {
+    static summary = 'Get a record from a resource';
+    static description = 'Get a record from a generic resource. Use --filter-by-tk for the primary key and association resource names with --source-id when needed.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --resource users --filter-by-tk 1',
+        '<%= config.bin %> <%= command.id %> --resource posts.comments --source-id 1 --filter-by-tk 2',
+    ];
+    static flags = getFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceGet);
+        await runResourceCommand(this, 'get', flags, buildGetArgs(flags));
+    }
+}

package/dist/commands/api/resource/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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, loadHelpClass } from '@oclif/core';
+export default class Resource extends Command {
+    static summary = 'Work with generic collection resources';
+    async run() {
+        await this.parse(Resource);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'api:resource',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/api/resource/list.js

@@ -0,0 +1,16 @@
+import { Command } from '@oclif/core';
+import { buildListArgs, listFlags, runResourceCommand } from '../../../lib/resource-command.js';
+export default class ResourceList extends Command {
+    static summary = 'List records from a resource';
+    static description = 'List records from a generic resource. Use association resource names like posts.comments with --source-id when needed.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --resource users',
+        '<%= config.bin %> <%= command.id %> --resource posts.comments --source-id 1 --fields id --fields content',
+        `<%= config.bin %> <%= command.id %> --resource users --filter '{"status":"active"}' --sort=-createdAt`,
+    ];
+    static flags = listFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceList);
+        await runResourceCommand(this, 'list', flags, buildListArgs(flags));
+    }
+}

package/dist/commands/api/resource/query.js

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+import { buildQueryArgs, queryFlags, runResourceCommand } from '../../../lib/resource-command.js';
+export default class ResourceQuery extends Command {
+    static summary = 'Run an aggregate query on a resource';
+    static description = 'Run an aggregate query on a generic resource. Pass measures, dimensions, and orders as JSON arrays.';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --resource orders --measures '[{"field":["id"],"aggregation":"count","alias":"count"}]'`,
+        `<%= config.bin %> <%= command.id %> --resource orders --dimensions '[{"field":["status"],"alias":"status"}]' --orders '[{"field":["createdAt"],"order":"desc"}]'`,
+    ];
+    static flags = queryFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceQuery);
+        await runResourceCommand(this, 'query', flags, buildQueryArgs(flags));
+    }
+}

package/dist/commands/api/resource/update.js

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+import { buildUpdateArgs, runResourceCommand, updateFlags } from '../../../lib/resource-command.js';
+export default class ResourceUpdate extends Command {
+    static summary = 'Update records in a resource';
+    static description = 'Update records in a generic resource. Target records with --filter-by-tk or --filter, and pass updated values through --values.';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --resource users --filter-by-tk 1 --values '{"nickname":"Grace"}'`,
+        `<%= config.bin %> <%= command.id %> --resource posts --filter '{"status":"draft"}' --values '{"status":"published"}'`,
+    ];
+    static flags = updateFlags;
+    async run() {
+        const { flags } = await this.parse(ResourceUpdate);
+        await runResourceCommand(this, 'update', flags, buildUpdateArgs(flags));
+    }
+}

package/dist/commands/build.js

@@ -0,0 +1,51 @@
+/**
+ * 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 { Args, Command, Flags } from '@oclif/core';
+import { runNocoBaseCommand } from "../lib/run-npm.js";
+export default class Build extends Command {
+    static args = {
+        /** Matches `nb build @nocobase/acl @nocobase/actions` — zero or more package names. */
+        packages: Args.string({
+            description: 'package names to build',
+            multiple: true,
+            required: false,
+        }),
+    };
+    static description = 'Run the legacy NocoBase build (forwards to `npm run build` in the repo root)';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --no-dts',
+        '<%= config.bin %> <%= command.id %> --sourcemap',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl',
+        '<%= config.bin %> <%= command.id %> @nocobase/acl @nocobase/actions',
+    ];
+    static flags = {
+        'cwd': Flags.string({ description: 'Current working directory', char: 'c', required: false }),
+        'no-dts': Flags.boolean({ description: 'not generate dts' }),
+        sourcemap: Flags.boolean({ description: 'generate sourcemap' }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Build);
+        const packages = args.packages ?? [];
+        const npmArgs = ['build', ...packages];
+        if (flags['no-dts']) {
+            npmArgs.push('--no-dts');
+        }
+        if (flags.sourcemap) {
+            npmArgs.push('--sourcemap');
+        }
+        try {
+            await runNocoBaseCommand(npmArgs, { cwd: flags['cwd'] });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(message);
+        }
+    }
+}

package/dist/commands/db/start.js

@@ -0,0 +1,22 @@
+/**
+ * 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 { Args, Command } from '@oclif/core';
+export default class DbStart extends Command {
+    static args = {
+        file: Args.string({ description: 'file to read' }),
+    };
+    static description = 'describe the command here';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    static flags = {};
+    async run() {
+        const { args, flags } = await this.parse(DbStart);
+    }
+}

package/dist/commands/dev.js

@@ -0,0 +1,58 @@
+/**
+ * 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 { Args, Command, Flags } from '@oclif/core';
+import { runNocoBaseCommand } from "../lib/run-npm.js";
+export default class Dev extends Command {
+    static args = {
+        file: Args.string({ description: 'file to read' }),
+    };
+    static description = 'describe the command here';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --db-sync',
+        '<%= config.bin %> <%= command.id %> --port 12000',
+        '<%= config.bin %> <%= command.id %> --client',
+        '<%= config.bin %> <%= command.id %> --server',
+        '<%= config.bin %> <%= command.id %> --inspect 9229',
+    ];
+    static flags = {
+        env: Flags.string({ description: 'Environment', char: 'e', required: false }),
+        'db-sync': Flags.boolean({ description: 'Sync the database', required: false }),
+        port: Flags.string({ description: 'Port', char: 'p', required: false }),
+        client: Flags.boolean({ description: 'Client', char: 'c', required: false }),
+        server: Flags.boolean({ description: 'Server', char: 's', required: false }),
+        inspect: Flags.string({ description: 'Inspect port', char: 'i', required: false }),
+    };
+    async run() {
+        const { flags } = await this.parse(Dev);
+        const npmArgs = ['dev', '--rsbuild'];
+        if (flags['db-sync']) {
+            npmArgs.push('--db-sync');
+        }
+        if (flags.port) {
+            npmArgs.push('--port', flags.port);
+        }
+        if (flags.client) {
+            npmArgs.push('--client');
+        }
+        if (flags.server) {
+            npmArgs.push('--server');
+        }
+        if (flags.inspect) {
+            npmArgs.push('--inspect', flags.inspect);
+        }
+        try {
+            await runNocoBaseCommand(npmArgs);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(message);
+        }
+    }
+}