@nocobase/ctl 0.1.5 → 0.1.7

package/README.md

@@ -36,7 +36,7 @@ node ./bin/run.js --help
 After packaging or linking, the executable name is:
 
 ```bash
-nocobase
+nocobase-ctl
 ```
 
 ## Quick Start
@@ -44,40 +44,40 @@ nocobase
 Add an environment:
 
 ```bash
-nocobase env add --name local --base-url http://localhost:13000/api --token <token>
+nocobase-ctl env add --name local --base-url http://localhost:13000/api --token <token>
 ```
 
 Show the current environment:
 
 ```bash
-nocobase env
+nocobase-ctl env
 ```
 
 List configured environments:
 
 ```bash
-nocobase env list
+nocobase-ctl env list
 ```
 
 Switch the current environment:
 
 ```bash
-nocobase env use local
+nocobase-ctl env use local
 ```
 
 Update the runtime command cache from `swagger:get`:
 
 ```bash
-nocobase env update
-nocobase env update -e local
+nocobase-ctl env update
+nocobase-ctl env update -e local
 ```
 
 Use the generic resource commands:
 
 ```bash
-nocobase resource list --resource users
-nocobase resource get --resource users --filter-by-tk 1
-nocobase resource create --resource users --values '{"nickname":"Ada"}'
+nocobase-ctl resource list --resource users
+nocobase-ctl resource get --resource users --filter-by-tk 1
+nocobase-ctl resource create --resource users --values '{"nickname":"Ada"}'
 ```
 
 ## Runtime Commands
@@ -96,34 +96,34 @@ If the `API documentation plugin` is disabled, the CLI will prompt to enable it.
 Use `-e, --env` to temporarily select an environment:
 
 ```bash
-nocobase env update -e prod
-nocobase resource list --resource users -e prod
+nocobase-ctl env update -e prod
+nocobase-ctl resource list --resource users -e prod
 ```
 
 This does not change the current environment unless you explicitly run:
 
 ```bash
-nocobase env use <name>
+nocobase-ctl 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
+- `project`: use `./.nocobase-ctl` in the current working directory
+- `global`: use the global `.nocobase-ctl` directory
 
 Use `-s, --scope` to select one explicitly:
 
 ```bash
-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
+nocobase-ctl env list -s project
+nocobase-ctl env add -s global --name prod --base-url http://example.com/api --token <token>
+nocobase-ctl env use local -s project
 ```
 
 If you do not pass `--scope`, the CLI uses automatic resolution:
 
-1. current working directory if `./.nocobase-cli` exists
+1. current working directory if `./.nocobase-ctl` exists
 2. `NOCOBASE_HOME_CLI`
 3. your home directory
 
@@ -137,9 +137,9 @@ Current built-in topics:
 Check available commands at any time:
 
 ```bash
-nocobase --help
-nocobase env --help
-nocobase resource --help
+nocobase-ctl --help
+nocobase-ctl env --help
+nocobase-ctl resource --help
 ```
 
 ## Common Flags
@@ -152,13 +152,13 @@ nocobase resource --help
 Example:
 
 ```bash
-nocobase env update -e prod -s global
-nocobase resource list --resource users -e prod -j
+nocobase-ctl env update -e prod -s global
+nocobase-ctl resource list --resource users -e prod -j
 ```
 
 ## Local Data
 
-The CLI stores its local state in `.nocobase-cli`, including:
+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/dev.js

@@ -8,7 +8,7 @@ import { fileURLToPath } from 'node:url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 await ensureRuntimeFromArgv(process.argv.slice(2), {
-  configFile: path.join(path.dirname(__dirname), 'nocobase-cli.config.json'),
+  configFile: path.join(path.dirname(__dirname), 'nocobase-ctl.config.json'),
 });
 
 await execute({ development: true, dir: import.meta.url });

package/bin/run.js

@@ -9,7 +9,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 try {
   await ensureRuntimeFromArgv(process.argv.slice(2), {
-    configFile: path.join(path.dirname(__dirname), 'nocobase-cli.config.json'),
+    configFile: path.join(path.dirname(__dirname), 'nocobase-ctl.config.json'),
   });
 
   await execute({ dir: import.meta.url });

package/dist/commands/env/index.js

@@ -19,7 +19,7 @@ export default class Env extends Command {
         const env = await getEnv(envName, { scope });
         if (!env?.baseUrl) {
             this.log(`No current env is configured${scope ? ` in ${formatCliHomeScope(scope)} scope` : ''}.`);
-            this.log('Run `nocobase env add --name <name> --base-url <url> --token <token>` to add one.');
+            this.log('Run `nocobase-ctl env add --name <name> --base-url <url> --token <token>` to add one.');
             return;
         }
         this.log(renderTable(['Name', 'Base URL', 'Runtime'], [[envName, env?.baseUrl ?? '', env?.runtime?.version ?? '']]));

package/dist/commands/env/list.js

@@ -19,7 +19,7 @@ export default class EnvList extends Command {
         const names = Object.keys(envs).sort();
         if (!names.length) {
             this.log(`No envs configured${scope ? ` in ${formatCliHomeScope(scope)} scope` : ''}.`);
-            this.log('Run `nocobase env add --name <name> --base-url <url> --token <token>` to add one.');
+            this.log('Run `nocobase-ctl env add --name <name> --base-url <url> --token <token>` to add one.');
             return;
         }
         const rows = names.map((name) => {

package/dist/commands/resource/index.js

@@ -2,6 +2,6 @@ import { Command } from '@oclif/core';
 export default class Resource extends Command {
     static summary = 'Work with generic collection resources';
     async run() {
-        this.log('Use `nocobase resource --help` to view available subcommands.');
+        this.log('Use `nocobase-ctl resource --help` to view available subcommands.');
     }
 }

package/dist/generated/command-registry.js

@@ -45,7 +45,7 @@ function createRuntimeIndexCommand(commandId, operation) {
         static summary = operation.resourceDescription || operation.resourceDisplayName || `Work with ${commandId}`;
         static description = operation.resourceDescription;
         async run() {
-            this.log(`Use \`nocobase ${commandId} --help\` to view available subcommands.`);
+            this.log(`Use \`nocobase-ctl ${commandId} --help\` to view available subcommands.`);
         }
     };
 }

package/dist/lib/api-client.js

@@ -9,7 +9,7 @@ async function resolveServerRequestTarget(options) {
     const baseUrl = options.baseUrl ?? env?.baseUrl;
     const token = options.token ?? env?.auth?.accessToken;
     if (!baseUrl) {
-        throw new Error('Missing base URL. Use --base-url or configure one with `nocobase env add`.');
+        throw new Error('Missing base URL. Use --base-url or configure one with `nocobase-ctl env add`.');
     }
     return { baseUrl, token };
 }

package/dist/lib/bootstrap.js

@@ -212,8 +212,8 @@ export async function ensureRuntimeFromArgv(argv, options) {
     if (!baseUrl) {
         throw new Error([
             'No env is configured for runtime commands.',
-            'Run `nocobase env add --name <name> --base-url <url> --token <token>` first.',
-            'If you configure multiple environments later, switch with `nocobase env use <name>`.',
+            'Run `nocobase-ctl env add --name <name> --base-url <url> --token <token>` first.',
+            'If you configure multiple environments later, switch with `nocobase-ctl env use <name>`.',
         ].join('\n'));
     }
     updateTask('Loading command runtime...');
@@ -241,7 +241,7 @@ export async function updateEnvRuntime(options) {
     if (!baseUrl) {
         throw new Error([
             `Env "${envName}" is missing a base URL.`,
-            'Update it with `nocobase env add --name <name> --base-url <url>` first.',
+            'Update it with `nocobase-ctl env add --name <name> --base-url <url>` first.',
         ].join('\n'));
     }
     updateTask('Loading command runtime...');

package/dist/lib/runtime-generator.js

@@ -181,7 +181,7 @@ function formatFlagExample(parameter) {
 }
 function buildExamples(commandId, operation) {
     const requiredFlags = operation.parameters.filter((parameter) => parameter.required).map(formatFlagExample);
-    const examples = [`nocobase ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}`];
+    const examples = [`nocobase-ctl ${commandId}${requiredFlags.length ? ` ${requiredFlags.join(' ')}` : ''}`];
     const firstOptional = operation.parameters.find((parameter) => !parameter.required);
     if (firstOptional) {
         examples.push(`${examples[0]} ${formatFlagExample(firstOptional)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/ctl",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",