@nocobase/cli 2.1.0-alpha.4 → 2.1.0-alpha.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (214) hide show
  1. package/LICENSE.txt +107 -0
  2. package/README.md +405 -19
  3. package/README.zh-CN.md +355 -0
  4. package/bin/run.cmd +3 -0
  5. package/bin/run.js +136 -0
  6. package/bin/session-env.js +39 -0
  7. package/dist/commands/api/resource/create.js +15 -0
  8. package/dist/commands/api/resource/destroy.js +15 -0
  9. package/dist/commands/api/resource/get.js +15 -0
  10. package/dist/commands/api/resource/index.js +20 -0
  11. package/dist/commands/api/resource/list.js +16 -0
  12. package/dist/commands/api/resource/query.js +15 -0
  13. package/dist/commands/api/resource/update.js +15 -0
  14. package/dist/commands/app/destroy.js +225 -0
  15. package/dist/commands/app/down.js +71 -0
  16. package/dist/commands/app/logs.js +114 -0
  17. package/dist/commands/app/restart.js +158 -0
  18. package/dist/commands/app/shared.js +122 -0
  19. package/dist/commands/app/start.js +286 -0
  20. package/dist/commands/app/stop.js +161 -0
  21. package/dist/commands/app/upgrade.js +519 -0
  22. package/dist/commands/backup/create.js +147 -0
  23. package/dist/commands/backup/index.js +20 -0
  24. package/dist/commands/backup/restore.js +105 -0
  25. package/{src/cli.js → dist/commands/build.js} +4 -11
  26. package/dist/commands/config/delete.js +34 -0
  27. package/dist/commands/config/get.js +33 -0
  28. package/dist/commands/config/index.js +20 -0
  29. package/dist/commands/config/list.js +29 -0
  30. package/dist/commands/config/set.js +39 -0
  31. package/dist/commands/db/check.js +240 -0
  32. package/dist/commands/db/logs.js +85 -0
  33. package/dist/commands/db/ps.js +60 -0
  34. package/dist/commands/db/shared.js +96 -0
  35. package/dist/commands/db/start.js +86 -0
  36. package/dist/commands/db/stop.js +71 -0
  37. package/{templates/plugin/src/client/models/index.ts → dist/commands/dev.js} +4 -4
  38. package/{src/commands/locale/react-js-cron/index.js → dist/commands/down.js} +3 -8
  39. package/dist/commands/download.js +13 -0
  40. package/dist/commands/env/add.js +426 -0
  41. package/dist/commands/env/auth.js +189 -0
  42. package/dist/commands/env/current.js +21 -0
  43. package/dist/commands/env/info.js +201 -0
  44. package/dist/commands/env/list.js +44 -0
  45. package/dist/commands/env/remove.js +84 -0
  46. package/dist/commands/env/shared.js +196 -0
  47. package/dist/commands/env/status.js +90 -0
  48. package/dist/commands/env/update.js +74 -0
  49. package/dist/commands/env/use.js +38 -0
  50. package/dist/commands/examples/prompts-stages.js +150 -0
  51. package/dist/commands/examples/prompts-test.js +181 -0
  52. package/dist/commands/init.js +1152 -0
  53. package/dist/commands/install.js +2424 -0
  54. package/dist/commands/license/activate.js +360 -0
  55. package/dist/commands/license/env.js +94 -0
  56. package/dist/commands/license/generate-id.js +108 -0
  57. package/dist/commands/license/id.js +70 -0
  58. package/dist/commands/license/index.js +20 -0
  59. package/dist/commands/license/plugins/clean.js +115 -0
  60. package/dist/commands/license/plugins/index.js +20 -0
  61. package/dist/commands/license/plugins/list.js +64 -0
  62. package/dist/commands/license/plugins/shared.js +331 -0
  63. package/dist/commands/license/plugins/sync.js +314 -0
  64. package/dist/commands/license/shared.js +423 -0
  65. package/dist/commands/license/status.js +64 -0
  66. package/dist/commands/logs.js +12 -0
  67. package/dist/commands/plugin/disable.js +86 -0
  68. package/dist/commands/plugin/enable.js +86 -0
  69. package/dist/commands/plugin/list.js +82 -0
  70. package/dist/commands/pm/disable.js +12 -0
  71. package/dist/commands/pm/enable.js +12 -0
  72. package/dist/commands/pm/list.js +12 -0
  73. package/dist/commands/restart.js +12 -0
  74. package/dist/commands/scaffold/migration.js +38 -0
  75. package/dist/commands/scaffold/plugin.js +37 -0
  76. package/dist/commands/self/check.js +71 -0
  77. package/dist/commands/self/index.js +20 -0
  78. package/dist/commands/self/update.js +95 -0
  79. package/dist/commands/session/id.js +24 -0
  80. package/dist/commands/session/remove.js +57 -0
  81. package/dist/commands/session/setup.js +62 -0
  82. package/dist/commands/skills/check.js +69 -0
  83. package/dist/commands/skills/index.js +20 -0
  84. package/dist/commands/skills/install.js +80 -0
  85. package/dist/commands/skills/remove.js +80 -0
  86. package/dist/commands/skills/update.js +87 -0
  87. package/dist/commands/source/build.js +58 -0
  88. package/dist/commands/source/dev.js +182 -0
  89. package/dist/commands/source/download.js +884 -0
  90. package/dist/commands/source/publish.js +109 -0
  91. package/dist/commands/source/registry/logs.js +70 -0
  92. package/dist/commands/source/registry/start.js +57 -0
  93. package/dist/commands/source/registry/status.js +33 -0
  94. package/dist/commands/source/registry/stop.js +48 -0
  95. package/dist/commands/source/test.js +477 -0
  96. package/dist/commands/start.js +12 -0
  97. package/dist/commands/stop.js +12 -0
  98. package/dist/commands/test.js +12 -0
  99. package/dist/commands/upgrade.js +12 -0
  100. package/dist/commands/v1.js +210 -0
  101. package/dist/generated/command-registry.js +134 -0
  102. package/dist/help/runtime-help.js +23 -0
  103. package/dist/lib/api-client.js +335 -0
  104. package/dist/lib/api-command-compat.js +641 -0
  105. package/dist/lib/app-health.js +132 -0
  106. package/dist/lib/app-managed-resources.js +316 -0
  107. package/dist/lib/app-runtime.js +180 -0
  108. package/dist/lib/auth-store.js +396 -0
  109. package/dist/lib/backup.js +171 -0
  110. package/dist/lib/bootstrap.js +403 -0
  111. package/dist/lib/build-config.js +18 -0
  112. package/dist/lib/builtin-db.js +86 -0
  113. package/dist/lib/cli-config.js +271 -0
  114. package/dist/lib/cli-home.js +47 -0
  115. package/dist/lib/cli-locale.js +141 -0
  116. package/dist/lib/command-discovery.js +39 -0
  117. package/dist/lib/db-connection-check.js +219 -0
  118. package/dist/lib/docker-env-file.js +52 -0
  119. package/dist/lib/docker-image.js +37 -0
  120. package/dist/lib/env-auth.js +952 -0
  121. package/dist/lib/env-config.js +95 -0
  122. package/dist/lib/env-guard.js +62 -0
  123. package/dist/lib/generated-command.js +203 -0
  124. package/dist/lib/http-request.js +49 -0
  125. package/dist/lib/inquirer-theme.js +17 -0
  126. package/dist/lib/inquirer.js +244 -0
  127. package/dist/lib/naming.js +70 -0
  128. package/dist/lib/object-utils.js +76 -0
  129. package/dist/lib/openapi.js +62 -0
  130. package/dist/lib/plugin-storage.js +64 -0
  131. package/dist/lib/post-processors.js +23 -0
  132. package/dist/lib/prompt-catalog-core.js +185 -0
  133. package/dist/lib/prompt-catalog-terminal.js +375 -0
  134. package/{src/index.js → dist/lib/prompt-catalog.js} +2 -6
  135. package/dist/lib/prompt-validators.js +258 -0
  136. package/dist/lib/prompt-web-ui.js +2227 -0
  137. package/dist/lib/resource-command.js +357 -0
  138. package/dist/lib/resource-request.js +104 -0
  139. package/dist/lib/run-npm.js +385 -0
  140. package/dist/lib/runtime-env-vars.js +32 -0
  141. package/dist/lib/runtime-generator.js +498 -0
  142. package/dist/lib/runtime-store.js +56 -0
  143. package/dist/lib/self-manager.js +301 -0
  144. package/dist/lib/session-id.js +17 -0
  145. package/dist/lib/session-integration.js +703 -0
  146. package/dist/lib/session-store.js +118 -0
  147. package/dist/lib/skills-manager.js +436 -0
  148. package/dist/lib/source-publish.js +306 -0
  149. package/dist/lib/source-registry.js +188 -0
  150. package/dist/lib/startup-update.js +285 -0
  151. package/dist/lib/ui.js +158 -0
  152. package/dist/locale/en-US.json +425 -0
  153. package/dist/locale/zh-CN.json +425 -0
  154. package/dist/post-processors/data-modeling.js +84 -0
  155. package/dist/post-processors/data-source-manager.js +138 -0
  156. package/dist/post-processors/index.js +19 -0
  157. package/nocobase-ctl.config.json +388 -0
  158. package/package.json +132 -26
  159. package/LICENSE +0 -661
  160. package/bin/index.js +0 -39
  161. package/nocobase.conf.tpl +0 -95
  162. package/src/commands/benchmark.js +0 -73
  163. package/src/commands/build.js +0 -49
  164. package/src/commands/clean.js +0 -30
  165. package/src/commands/client.js +0 -166
  166. package/src/commands/create-nginx-conf.js +0 -37
  167. package/src/commands/create-plugin.js +0 -33
  168. package/src/commands/dev.js +0 -200
  169. package/src/commands/doc.js +0 -76
  170. package/src/commands/e2e.js +0 -265
  171. package/src/commands/global.js +0 -43
  172. package/src/commands/index.js +0 -45
  173. package/src/commands/instance-id.js +0 -47
  174. package/src/commands/locale/cronstrue.js +0 -122
  175. package/src/commands/locale/react-js-cron/en-US.json +0 -75
  176. package/src/commands/locale/react-js-cron/zh-CN.json +0 -33
  177. package/src/commands/locale/react-js-cron/zh-TW.json +0 -33
  178. package/src/commands/locale.js +0 -81
  179. package/src/commands/p-test.js +0 -88
  180. package/src/commands/perf.js +0 -63
  181. package/src/commands/pkg.js +0 -321
  182. package/src/commands/pm2.js +0 -37
  183. package/src/commands/postinstall.js +0 -88
  184. package/src/commands/start.js +0 -148
  185. package/src/commands/tar.js +0 -36
  186. package/src/commands/test-coverage.js +0 -55
  187. package/src/commands/test.js +0 -107
  188. package/src/commands/umi.js +0 -33
  189. package/src/commands/update-deps.js +0 -72
  190. package/src/commands/upgrade.js +0 -47
  191. package/src/commands/view-license-key.js +0 -44
  192. package/src/license.js +0 -76
  193. package/src/logger.js +0 -75
  194. package/src/plugin-generator.js +0 -80
  195. package/src/util.js +0 -517
  196. package/templates/bundle-status.html +0 -338
  197. package/templates/create-app-package.json +0 -39
  198. package/templates/plugin/.npmignore.tpl +0 -2
  199. package/templates/plugin/README.md.tpl +0 -1
  200. package/templates/plugin/client.d.ts +0 -2
  201. package/templates/plugin/client.js +0 -1
  202. package/templates/plugin/package.json.tpl +0 -11
  203. package/templates/plugin/server.d.ts +0 -2
  204. package/templates/plugin/server.js +0 -1
  205. package/templates/plugin/src/client/client.d.ts +0 -249
  206. package/templates/plugin/src/client/index.tsx.tpl +0 -1
  207. package/templates/plugin/src/client/locale.ts +0 -21
  208. package/templates/plugin/src/client/plugin.tsx.tpl +0 -10
  209. package/templates/plugin/src/index.ts +0 -2
  210. package/templates/plugin/src/locale/en-US.json +0 -1
  211. package/templates/plugin/src/locale/zh-CN.json +0 -1
  212. package/templates/plugin/src/server/collections/.gitkeep +0 -0
  213. package/templates/plugin/src/server/index.ts.tpl +0 -1
  214. package/templates/plugin/src/server/plugin.ts.tpl +0 -19
@@ -0,0 +1,82 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, Flags } from '@oclif/core';
10
+ import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runDockerNocoBaseCommand, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
11
+ import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
12
+ export default class PluginList extends Command {
13
+ static hidden = false;
14
+ static args = {};
15
+ static summary = 'List plugins for the selected env';
16
+ static description = 'List installed plugins in the selected env (npm/git runs locally, Docker runs inside the saved app container, HTTP envs fall back to the API)';
17
+ static examples = [
18
+ '<%= config.bin %> <%= command.id %>',
19
+ '<%= config.bin %> <%= command.id %> -e local',
20
+ '<%= config.bin %> <%= command.id %> -e local-docker',
21
+ ];
22
+ static flags = {
23
+ env: Flags.string({
24
+ char: 'e',
25
+ description: 'CLI env name to inspect plugins for. Defaults to the current env when omitted',
26
+ }),
27
+ yes: Flags.boolean({
28
+ char: 'y',
29
+ description: 'Confirm using --env when it targets a different env than the current env',
30
+ default: false,
31
+ }),
32
+ };
33
+ async run() {
34
+ const { flags } = await this.parse(PluginList);
35
+ const requestedEnv = flags.env?.trim() || undefined;
36
+ const explicitEnvSelection = Boolean(requestedEnv && hasExplicitEnvSelection(this.argv));
37
+ if (explicitEnvSelection) {
38
+ const confirmed = await ensureCrossEnvConfirmed({
39
+ command: this,
40
+ requestedEnv,
41
+ yes: flags.yes,
42
+ });
43
+ if (!confirmed) {
44
+ return;
45
+ }
46
+ }
47
+ const runtime = await resolveManagedAppRuntime(requestedEnv);
48
+ if (!runtime) {
49
+ this.error(formatMissingManagedAppEnvMessage(requestedEnv));
50
+ }
51
+ if (runtime.kind === 'local') {
52
+ try {
53
+ await runLocalNocoBaseCommand(runtime, ['pm', 'list']);
54
+ }
55
+ catch (error) {
56
+ const message = error instanceof Error ? error.message : String(error);
57
+ this.error(message);
58
+ }
59
+ return;
60
+ }
61
+ if (runtime.kind === 'docker') {
62
+ try {
63
+ await runDockerNocoBaseCommand(runtime.containerName, ['pm', 'list']);
64
+ }
65
+ catch (error) {
66
+ const message = error instanceof Error ? error.message : String(error);
67
+ this.error(message);
68
+ }
69
+ return;
70
+ }
71
+ if (runtime.kind === 'ssh') {
72
+ this.error([
73
+ `Can't list plugins for "${runtime.envName}" yet.`,
74
+ 'SSH env support is reserved but not implemented yet.',
75
+ 'Use a local, Docker, or HTTP env for plugin inspection right now.',
76
+ ].join('\n'));
77
+ }
78
+ await this.config.runCommand('api:pm:list', explicitEnvSelection
79
+ ? ['--mode=summary', '--env', runtime.envName, '--yes']
80
+ : ['--mode=summary']);
81
+ }
82
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import PluginDisable from '../plugin/disable.js';
10
+ export default class PmDisable extends PluginDisable {
11
+ static hidden = true;
12
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import PluginEnable from '../plugin/enable.js';
10
+ export default class PmEnable extends PluginEnable {
11
+ static hidden = true;
12
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import PluginList from '../plugin/list.js';
10
+ export default class PmList extends PluginList {
11
+ static hidden = true;
12
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import AppRestart from './app/restart.js';
10
+ export default class Restart extends AppRestart {
11
+ static hidden = true;
12
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Args, Command, Flags } from '@oclif/core';
10
+ import { runNocoBaseCommand } from "../../lib/run-npm.js";
11
+ export default class ScaffoldMigration extends Command {
12
+ static args = {
13
+ name: Args.string({ description: 'migration name', required: true }),
14
+ };
15
+ static description = 'Generate a plugin migration file.';
16
+ static examples = [
17
+ '<%= config.bin %> <%= command.id %> migration-name --pkg @nocobase/plugin-acl',
18
+ '<%= config.bin %> <%= command.id %> migration-name --pkg @nocobase/plugin-acl --on afterLoad',
19
+ ];
20
+ static flags = {
21
+ pkg: Flags.string({ description: 'plugin package name', required: true }),
22
+ on: Flags.string({ description: 'on', required: false, options: ['beforeLoad', 'afterSync', 'afterLoad'] }),
23
+ };
24
+ async run() {
25
+ const { args, flags } = await this.parse(ScaffoldMigration);
26
+ const npmArgs = ['create-migration', args.name, '--pkg', flags.pkg];
27
+ if (flags.on) {
28
+ npmArgs.push('--on', flags.on);
29
+ }
30
+ try {
31
+ await runNocoBaseCommand(npmArgs, { env: { LOGGER_SILENT: 'true' } });
32
+ }
33
+ catch (error) {
34
+ const message = error instanceof Error ? error.message : String(error);
35
+ this.error(message);
36
+ }
37
+ }
38
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Args, Command, Flags } from '@oclif/core';
10
+ import { runNocoBaseCommand } from "../../lib/run-npm.js";
11
+ export default class ScaffoldPlugin extends Command {
12
+ static args = {
13
+ pkg: Args.string({ description: 'plugin package name', required: true }),
14
+ };
15
+ static description = 'Generate a NocoBase plugin scaffold.';
16
+ static examples = [
17
+ '<%= config.bin %> <%= command.id %> @nocobase-example/plugin-hello',
18
+ '<%= config.bin %> <%= command.id %> @nocobase-example/plugin-hello --force-recreate',
19
+ ];
20
+ static flags = {
21
+ 'force-recreate': Flags.boolean({ description: 'Force recreate the plugin', char: 'f', required: false }),
22
+ };
23
+ async run() {
24
+ const { args, flags } = await this.parse(ScaffoldPlugin);
25
+ const npmArgs = ['pm', 'create', args.pkg];
26
+ if (flags['force-recreate']) {
27
+ npmArgs.push('--force-recreate');
28
+ }
29
+ try {
30
+ await runNocoBaseCommand(npmArgs, { env: { LOGGER_SILENT: 'true' } });
31
+ }
32
+ catch (error) {
33
+ const message = error instanceof Error ? error.message : String(error);
34
+ this.error(message);
35
+ }
36
+ }
37
+ }
@@ -0,0 +1,71 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, Flags } from '@oclif/core';
10
+ import { getRecommendedSelfUpdateCommand, inspectSelfStatus, } from '../../lib/self-manager.js';
11
+ import { printInfo, renderTable } from '../../lib/ui.js';
12
+ export default class SelfCheck extends Command {
13
+ static summary = 'Check the installed NocoBase CLI version and self-update support';
14
+ static description = 'Inspect the current NocoBase CLI install, resolve the latest version for the selected channel, and report whether automatic self-update is supported.';
15
+ static examples = [
16
+ '<%= config.bin %> <%= command.id %>',
17
+ '<%= config.bin %> <%= command.id %> --channel beta',
18
+ '<%= config.bin %> <%= command.id %> --json',
19
+ ];
20
+ static flags = {
21
+ channel: Flags.string({
22
+ description: 'Release channel to compare against. Defaults to the current CLI channel.',
23
+ options: ['auto', 'latest', 'beta', 'alpha'],
24
+ default: 'auto',
25
+ }),
26
+ json: Flags.boolean({
27
+ description: 'Output the result as JSON',
28
+ default: false,
29
+ }),
30
+ };
31
+ async run() {
32
+ const { flags } = await this.parse(SelfCheck);
33
+ const status = await inspectSelfStatus({
34
+ channel: flags.channel,
35
+ });
36
+ if (flags.json) {
37
+ this.log(JSON.stringify({
38
+ ok: true,
39
+ kind: 'self',
40
+ packageName: status.packageName,
41
+ currentVersion: status.currentVersion,
42
+ latestVersion: status.latestVersion,
43
+ channel: status.channel,
44
+ updateAvailable: status.updateAvailable,
45
+ installMethod: status.installMethod,
46
+ updatable: status.updatable,
47
+ updateBlockedReason: status.updateBlockedReason,
48
+ recommendedCommand: getRecommendedSelfUpdateCommand(status),
49
+ registryError: status.registryError,
50
+ }, null, 2));
51
+ return;
52
+ }
53
+ this.log(renderTable(['Field', 'Value'], [
54
+ ['Current version', status.currentVersion || 'unknown'],
55
+ ['Latest version', status.latestVersion || 'unknown'],
56
+ ['Channel', status.channel],
57
+ ['Install method', status.installMethod],
58
+ ['Auto-update', status.updatable ? 'supported' : 'not supported'],
59
+ ['Update available', status.updateAvailable ? 'yes' : 'no'],
60
+ ]));
61
+ if (status.updateAvailable && status.updatable) {
62
+ printInfo('Run `nb self update`.');
63
+ }
64
+ else if (status.updateAvailable && status.updateBlockedReason) {
65
+ printInfo(status.updateBlockedReason);
66
+ }
67
+ if (status.registryError) {
68
+ printInfo(`Version check warning: ${status.registryError}`);
69
+ }
70
+ }
71
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, loadHelpClass } from '@oclif/core';
10
+ export default class Self extends Command {
11
+ static summary = 'Inspect or update the NocoBase CLI itself';
12
+ async run() {
13
+ await this.parse(Self);
14
+ const Help = await loadHelpClass(this.config);
15
+ await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
16
+ this.id ?? 'self',
17
+ ...this.argv,
18
+ ]);
19
+ }
20
+ }
@@ -0,0 +1,95 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, Flags } from '@oclif/core';
10
+ import { confirm } from "../../lib/inquirer.js";
11
+ import { setVerboseMode } from '../../lib/ui.js';
12
+ import { formatSelfUpdateUnavailableMessage, formatUnsupportedSelfUpdateMessage, inspectSelfStatus, updateSelf, } from '../../lib/self-manager.js';
13
+ export default class SelfUpdate extends Command {
14
+ static summary = 'Update the globally installed NocoBase CLI';
15
+ static description = 'Update the current NocoBase CLI install when it is managed by a standard global npm install.';
16
+ static examples = [
17
+ '<%= config.bin %> <%= command.id %>',
18
+ '<%= config.bin %> <%= command.id %> --yes',
19
+ '<%= config.bin %> <%= command.id %> --channel alpha --json',
20
+ ];
21
+ static flags = {
22
+ channel: Flags.string({
23
+ description: 'Release channel to update to. Defaults to the current CLI channel.',
24
+ options: ['auto', 'latest', 'beta', 'alpha'],
25
+ default: 'auto',
26
+ }),
27
+ yes: Flags.boolean({
28
+ char: 'y',
29
+ description: 'Skip the update confirmation prompt',
30
+ default: false,
31
+ }),
32
+ json: Flags.boolean({
33
+ description: 'Output the result as JSON',
34
+ default: false,
35
+ }),
36
+ verbose: Flags.boolean({
37
+ description: 'Show detailed update output',
38
+ default: false,
39
+ }),
40
+ };
41
+ async run() {
42
+ const { flags } = await this.parse(SelfUpdate);
43
+ setVerboseMode(flags.verbose);
44
+ const status = await inspectSelfStatus({
45
+ channel: flags.channel,
46
+ });
47
+ if (!status.updatable) {
48
+ this.error(formatUnsupportedSelfUpdateMessage(status));
49
+ }
50
+ if (!status.latestVersion && status.registryError) {
51
+ this.error(formatSelfUpdateUnavailableMessage(status));
52
+ }
53
+ if (!flags.yes && status.updateAvailable) {
54
+ let confirmed = false;
55
+ try {
56
+ confirmed = await confirm({
57
+ message: `Update ${status.packageName} from ${status.currentVersion} to ${status.latestVersion}?`,
58
+ default: false,
59
+ });
60
+ }
61
+ catch {
62
+ return;
63
+ }
64
+ if (!confirmed) {
65
+ return;
66
+ }
67
+ }
68
+ const result = await updateSelf({
69
+ channel: flags.channel,
70
+ verbose: flags.verbose,
71
+ });
72
+ if (flags.json) {
73
+ this.log(JSON.stringify({
74
+ ok: true,
75
+ kind: 'self',
76
+ action: result.action,
77
+ packageName: result.status.packageName,
78
+ packageSpec: result.packageSpec,
79
+ channel: result.status.channel,
80
+ fromVersion: result.status.currentVersion,
81
+ toVersion: result.targetVersion,
82
+ }, null, 2));
83
+ return;
84
+ }
85
+ if (result.action === 'noop') {
86
+ this.log(flags.verbose
87
+ ? `NocoBase CLI is already up to date at ${result.status.currentVersion}.`
88
+ : `NocoBase CLI is up to date: ${result.status.currentVersion}.`);
89
+ return;
90
+ }
91
+ this.log(flags.verbose
92
+ ? `Updated NocoBase CLI from ${result.status.currentVersion} using ${result.packageSpec}${result.targetVersion ? ` (latest ${result.status.channel} resolves to ${result.targetVersion})` : ''}.`
93
+ : `Updated NocoBase CLI: ${result.status.currentVersion} -> ${result.targetVersion}.`);
94
+ }
95
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command } from '@oclif/core';
10
+ import { resolveSessionIdentity } from '../../lib/session-id.js';
11
+ export default class SessionId extends Command {
12
+ static summary = 'Show the current effective session id';
13
+ static examples = [
14
+ '<%= config.bin %> <%= command.id %>',
15
+ ];
16
+ async run() {
17
+ await this.parse(SessionId);
18
+ const identity = resolveSessionIdentity();
19
+ if (!identity) {
20
+ this.error('No effective session id is available. Run `nb session setup`, then open a new shell session or runtime.');
21
+ }
22
+ this.log(identity.id);
23
+ }
24
+ }
@@ -0,0 +1,57 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ /**
10
+ * This file is part of the NocoBase (R) project.
11
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
12
+ * Authors: NocoBase Team.
13
+ *
14
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
15
+ * For more information, please refer to: https://www.nocobase.com/agreement.
16
+ */
17
+ import { Command, Flags } from '@oclif/core';
18
+ import { detectSessionShell, removeSessionIntegration } from '../../lib/session-integration.js';
19
+ export default class SessionRemove extends Command {
20
+ static summary = 'Remove shell session integration for NB_SESSION_ID';
21
+ static examples = [
22
+ '<%= config.bin %> <%= command.id %>',
23
+ '<%= config.bin %> <%= command.id %> --shell zsh',
24
+ ];
25
+ static flags = {
26
+ shell: Flags.string({
27
+ description: 'Target shell to remove configuration from',
28
+ options: ['bash', 'zsh', 'fish', 'powershell', 'cmd'],
29
+ }),
30
+ };
31
+ async run() {
32
+ const { flags } = await this.parse(SessionRemove);
33
+ const shell = flags.shell ?? detectSessionShell();
34
+ if (!shell) {
35
+ this.error('Could not detect the current shell. Re-run with `--shell bash|zsh|fish|powershell|cmd`.');
36
+ }
37
+ const result = await removeSessionIntegration(shell);
38
+ this.log(`Session integration removed for ${result.shell}.`);
39
+ if (result.profileUpdated) {
40
+ for (const profileFile of result.profileFiles) {
41
+ this.log(`Profile updated: ${profileFile}`);
42
+ }
43
+ }
44
+ if (result.managedFileRemoved) {
45
+ this.log(`Managed file removed: ${result.managedFile}`);
46
+ }
47
+ if (result.cmdAutoRunRemoved) {
48
+ this.log(`cmd AutoRun updated: ${result.cmdAutoRunLocation}`);
49
+ }
50
+ if (result.agentConfigUpdated) {
51
+ this.log(`Opencode config updated: ${result.agentConfigFile}`);
52
+ }
53
+ if (result.agentPluginRemoved) {
54
+ this.log(`Opencode agent plugin removed: ${result.agentPluginFile}`);
55
+ }
56
+ }
57
+ }
@@ -0,0 +1,62 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ /**
10
+ * This file is part of the NocoBase (R) project.
11
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
12
+ * Authors: NocoBase Team.
13
+ *
14
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
15
+ * For more information, please refer to: https://www.nocobase.com/agreement.
16
+ */
17
+ import { Command, Flags } from '@oclif/core';
18
+ import { detectSessionShell, setupSessionIntegration } from '../../lib/session-integration.js';
19
+ export default class SessionSetup extends Command {
20
+ static summary = 'Set up shell session integration for NB_SESSION_ID';
21
+ static examples = [
22
+ '<%= config.bin %> <%= command.id %>',
23
+ '<%= config.bin %> <%= command.id %> --shell zsh',
24
+ '<%= config.bin %> <%= command.id %> --shell powershell',
25
+ ];
26
+ static flags = {
27
+ shell: Flags.string({
28
+ description: 'Target shell to configure',
29
+ options: ['bash', 'zsh', 'fish', 'powershell', 'cmd'],
30
+ }),
31
+ };
32
+ async run() {
33
+ const { flags } = await this.parse(SessionSetup);
34
+ const shell = flags.shell ?? detectSessionShell();
35
+ if (!shell) {
36
+ this.error('Could not detect the current shell. Re-run with `--shell bash|zsh|fish|powershell|cmd`.');
37
+ }
38
+ const result = await setupSessionIntegration(shell);
39
+ this.log(`Session integration configured for ${result.shell}.`);
40
+ this.log(`Managed file: ${result.managedFile}`);
41
+ if (result.cmdAutoRunConfigured) {
42
+ this.log(`cmd AutoRun updated: ${result.cmdAutoRunLocation}`);
43
+ this.log('Open a new cmd session to initialize NB_SESSION_ID automatically.');
44
+ }
45
+ if (result.agentConfigured) {
46
+ this.log(`Opencode agent plugin installed: ${result.agentPluginFile}`);
47
+ this.log(`Opencode config updated: ${result.agentConfigFile}`);
48
+ }
49
+ else if (result.agentSkippedReason === 'opencode_dir_not_found') {
50
+ this.log('Opencode config directory not found. Skipped agent session integration.');
51
+ }
52
+ if (result.profileFiles.length > 0) {
53
+ for (const profileFile of result.profileFiles) {
54
+ this.log(`Profile updated: ${profileFile}`);
55
+ }
56
+ this.log('Open a new shell session or reload your profile to initialize NB_SESSION_ID automatically.');
57
+ }
58
+ if (result.manualStep) {
59
+ this.log(result.manualStep);
60
+ }
61
+ }
62
+ }
@@ -0,0 +1,69 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, Flags } from '@oclif/core';
10
+ import { inspectSkillsStatus } from '../../lib/skills-manager.js';
11
+ import { printInfo, renderTable } from '../../lib/ui.js';
12
+ export default class SkillsCheck extends Command {
13
+ static summary = 'Check the globally installed NocoBase AI coding skills';
14
+ static description = 'Inspect the global NocoBase AI coding skills and report whether they are managed by the CLI and whether an update is available.';
15
+ static examples = [
16
+ '<%= config.bin %> <%= command.id %>',
17
+ '<%= config.bin %> <%= command.id %> --json',
18
+ ];
19
+ static flags = {
20
+ json: Flags.boolean({
21
+ description: 'Output the result as JSON',
22
+ default: false,
23
+ }),
24
+ };
25
+ async run() {
26
+ const { flags } = await this.parse(SkillsCheck);
27
+ const status = await inspectSkillsStatus();
28
+ if (flags.json) {
29
+ this.log(JSON.stringify({
30
+ ok: true,
31
+ kind: 'skills',
32
+ globalRoot: status.globalRoot,
33
+ workspaceRoot: status.workspaceRoot,
34
+ installed: status.installed,
35
+ managedByNb: status.managedByNb,
36
+ sourcePackage: status.sourcePackage,
37
+ npmPackageName: status.npmPackageName,
38
+ installedSkillNames: status.installedSkillNames,
39
+ installedVersion: status.installedVersion,
40
+ latestVersion: status.latestVersion,
41
+ installedRef: status.installedRef,
42
+ latestRef: status.latestRef,
43
+ updateAvailable: status.updateAvailable,
44
+ recommendedCommand: status.installed ? 'nb skills update --yes' : 'nb skills install --yes',
45
+ registryError: status.registryError,
46
+ }, null, 2));
47
+ return;
48
+ }
49
+ this.log(renderTable(['Field', 'Value'], [
50
+ ['Skills home', status.globalRoot],
51
+ ['Installed', status.installed ? 'yes' : 'no'],
52
+ ['Managed by nb', status.managedByNb ? 'yes' : 'no'],
53
+ ['Installed skills', status.installedSkillNames.length ? status.installedSkillNames.join(', ') : '(none)'],
54
+ ['Installed version', status.installedVersion ?? '(unknown)'],
55
+ ['Latest version', status.latestVersion ?? '(unknown)'],
56
+ ['Update available', status.updateAvailable === null ? 'unknown' : status.updateAvailable ? 'yes' : 'no'],
57
+ ]));
58
+ if (!status.installed) {
59
+ printInfo('Run `nb skills install` to install the NocoBase AI coding skills globally.');
60
+ return;
61
+ }
62
+ if (status.updateAvailable) {
63
+ printInfo('Run `nb skills update` to refresh the global NocoBase AI coding skills.');
64
+ }
65
+ if (status.registryError) {
66
+ printInfo(`Update check warning: ${status.registryError}`);
67
+ }
68
+ }
69
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, loadHelpClass } from '@oclif/core';
10
+ export default class Skills extends Command {
11
+ static summary = 'Inspect or synchronize global NocoBase AI coding skills';
12
+ async run() {
13
+ await this.parse(Skills);
14
+ const Help = await loadHelpClass(this.config);
15
+ await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
16
+ this.id ?? 'skills',
17
+ ...this.argv,
18
+ ]);
19
+ }
20
+ }