@nocobase/plugin-ai 2.2.0-beta.1 → 2.2.0-beta.3

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 (243) hide show
  1. package/dist/ai/docs/nocobase/ai/ai-quick-start.md +1 -1
  2. package/dist/ai/docs/nocobase/ai/claude-code/index.md +2 -2
  3. package/dist/ai/docs/nocobase/ai/codex/index.md +2 -2
  4. package/dist/ai/docs/nocobase/ai/hermes-agent/index.md +2 -2
  5. package/dist/ai/docs/nocobase/ai/index.md +1 -1
  6. package/dist/ai/docs/nocobase/ai/install-nocobase-app.md +117 -0
  7. package/dist/ai/docs/nocobase/ai/local-development-setup.md +94 -0
  8. package/dist/ai/docs/nocobase/ai/openclaw/index.md +2 -2
  9. package/dist/ai/docs/nocobase/ai/opencode/index.md +2 -2
  10. package/dist/ai/docs/nocobase/ai/quick-start.mdx +22 -15
  11. package/dist/ai/docs/nocobase/ai/upgrade-from-2-0-to-2-1.md +57 -0
  12. package/dist/ai/docs/nocobase/ai/upgrade-nocobase-app.md +111 -0
  13. package/dist/ai/docs/nocobase/ai/windows-wsl.md +409 -0
  14. package/dist/ai/docs/nocobase/ai/workbuddy/index.md +2 -2
  15. package/dist/ai/docs/nocobase/ai-builder/index.md +17 -2
  16. package/dist/ai/docs/nocobase/ai-builder/version-control.md +120 -0
  17. package/dist/ai/docs/nocobase/ai-dev/index.md +1 -1
  18. package/dist/ai/docs/nocobase/api/cli/init.md +2 -2
  19. package/dist/ai/docs/nocobase/api/cli/plugin/import.md +1 -1
  20. package/dist/ai/docs/nocobase/api/cli/skills/install.md +1 -0
  21. package/dist/ai/docs/nocobase/api/cli/skills/update.md +1 -0
  22. package/dist/ai/docs/nocobase/get-started/how-nocobase-works.mdx +8 -1
  23. package/dist/ai/docs/nocobase/get-started/quickstart.md +6 -1
  24. package/dist/ai/docs/nocobase/get-started/system-requirements.md +9 -1
  25. package/dist/ai/docs/nocobase/index.md +7 -10
  26. package/dist/ai/docs/nocobase/interface-builder/blocks/data-blocks/gantt.md +204 -0
  27. package/dist/ai/docs/nocobase/interface-builder/blocks/data-blocks/map.md +105 -0
  28. package/dist/ai/docs/nocobase/interface-builder/fields/field-settings/scan-input.md +43 -0
  29. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/index.md +6 -6
  30. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/cli.md +3 -9
  31. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/env.md +3 -3
  32. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/migration.md +1 -1
  33. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/index.md +1 -1
  34. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/caddy.md +1 -1
  35. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/index.md +1 -1
  36. package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/nginx.md +1 -1
  37. package/dist/ai/docs/nocobase/ops-management/version-control/index.md +21 -6
  38. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-acl/index.md +5 -3
  39. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-bulk-edit/index.md +5 -3
  40. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-bulk-update/index.md +5 -3
  41. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-custom-request/index.md +5 -2
  42. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-duplicate/index.md +4 -2
  43. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-export/index.md +4 -2
  44. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-export-pro/index.md +3 -1
  45. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-import/index.md +4 -2
  46. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-import-pro/index.md +3 -1
  47. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-print/index.md +3 -1
  48. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-action-template-print/index.md +5 -3
  49. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ai/index.md +6 -2
  50. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ai-gigachat/index.md +3 -1
  51. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ai-knowledge-base/index.md +2 -0
  52. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-api-doc/index.md +4 -2
  53. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-api-keys/index.md +5 -3
  54. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-app-sso/index.md +16 -0
  55. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-app-supervisor/index.md +5 -3
  56. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-async-task-manager/index.md +5 -3
  57. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-audit-logger/index.md +2 -0
  58. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-audit-logs/index.md +3 -1
  59. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth/index.md +3 -1
  60. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-cas/index.md +3 -1
  61. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-dingtalk/index.md +5 -3
  62. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-ldap/index.md +3 -1
  63. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-oidc/index.md +3 -1
  64. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-saml/index.md +3 -1
  65. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-sms/index.md +5 -3
  66. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-auth-wecom/index.md +5 -3
  67. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-backup-restore/index.md +3 -1
  68. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-backups/index.md +5 -3
  69. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-grid-card/index.md +4 -2
  70. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-iframe/index.md +3 -1
  71. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-list/index.md +3 -1
  72. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-markdown/index.md +4 -2
  73. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-multi-step-form/index.md +6 -1
  74. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-template/index.md +3 -1
  75. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-tree/index.md +3 -1
  76. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-workbench/index.md +3 -1
  77. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-calendar/index.md +4 -2
  78. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-charts/index.md +5 -1
  79. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-client/index.md +4 -2
  80. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-collection-fdw/index.md +3 -1
  81. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-collection-sql/index.md +3 -1
  82. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-collection-tree/index.md +3 -1
  83. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-comments/index.md +3 -1
  84. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-custom-brand/index.md +2 -0
  85. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-custom-variables/index.md +3 -1
  86. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-clickhouse/index.md +5 -3
  87. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-doris/index.md +5 -3
  88. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-mariadb/index.md +3 -1
  89. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-mssql/index.md +3 -1
  90. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-mysql/index.md +3 -1
  91. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-nocobase/index.md +16 -0
  92. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-oracle/index.md +5 -3
  93. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-external-postgres/index.md +3 -1
  94. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-kingbase/index.md +4 -2
  95. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-main/index.md +5 -3
  96. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-manager/index.md +5 -3
  97. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-source-rest-api/index.md +3 -1
  98. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-visualization/index.md +5 -3
  99. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-data-visualization-echarts/index.md +8 -4
  100. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-departments/index.md +3 -1
  101. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-email-manager/index.md +4 -2
  102. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-embed/index.md +4 -1
  103. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-environment-variables/index.md +3 -1
  104. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-error-handler/index.md +3 -1
  105. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-attachment-url/index.md +4 -2
  106. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-china-region/index.md +5 -3
  107. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-code/index.md +3 -1
  108. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-component-mask/index.md +5 -3
  109. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-encryption/index.md +2 -0
  110. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-formula/index.md +3 -1
  111. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-m2m-array/index.md +5 -3
  112. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-markdown-vditor/index.md +4 -2
  113. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-sequence/index.md +3 -1
  114. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-signature/index.md +3 -1
  115. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-field-sort/index.md +3 -1
  116. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-file-manager/index.md +5 -3
  117. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-file-previewer-office/index.md +5 -3
  118. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-file-storage-s3-pro/index.md +4 -2
  119. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-flow-engine/index.md +4 -2
  120. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-form-drafts/index.md +5 -3
  121. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-gantt/index.md +3 -1
  122. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-graph-collection-manager/index.md +8 -1
  123. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-idp-oauth/index.md +14 -0
  124. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ip-restriction/index.md +2 -0
  125. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-kanban/index.md +4 -2
  126. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-license/index.md +3 -1
  127. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-locale-tester/index.md +3 -1
  128. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-localization/index.md +4 -2
  129. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-lock-adapter-redis/index.md +2 -0
  130. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-logger/index.md +4 -2
  131. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-map/index.md +87 -3
  132. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-mcp-server/index.md +14 -0
  133. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-migration-manager/index.md +5 -3
  134. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-mobile/index.md +8 -1
  135. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-mobile-client/index.md +7 -3
  136. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-multi-app-manager/index.md +3 -1
  137. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-multi-app-share-collection/index.md +3 -1
  138. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-multi-keyword-filter/index.md +4 -1
  139. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-multi-space/index.md +5 -3
  140. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-notification-email/index.md +3 -1
  141. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-notification-in-app-message/index.md +3 -1
  142. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-notification-manager/index.md +5 -3
  143. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-password-policy/index.md +2 -0
  144. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-public-forms/index.md +5 -3
  145. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-pubsub-adapter-redis/index.md +2 -0
  146. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-queue-adapter-rabbitmq/index.md +2 -0
  147. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-queue-adapter-redis/index.md +2 -0
  148. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-record-history/index.md +2 -0
  149. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-request-encryption/index.md +2 -0
  150. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-snapshot-field/index.md +6 -4
  151. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-system-settings/index.md +3 -1
  152. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-telemetry/index.md +2 -0
  153. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-telemetry-prometheus/index.md +2 -0
  154. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-text-copy/index.md +5 -3
  155. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-theme-editor/index.md +4 -2
  156. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-two-factor-authentication/index.md +2 -0
  157. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ui-schema-storage/index.md +4 -2
  158. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-ui-templates/index.md +4 -2
  159. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-user-data-sync/index.md +5 -3
  160. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-users/index.md +4 -2
  161. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-verification/index.md +3 -1
  162. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-verification-totp-authenticator/index.md +2 -0
  163. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-version-control/index.md +3 -1
  164. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workerid-allocator-redis/index.md +4 -2
  165. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow/index.md +3 -1
  166. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-action-trigger/index.md +4 -2
  167. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-aggregate/index.md +5 -3
  168. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-approval/index.md +4 -2
  169. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-cc/index.md +3 -1
  170. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-custom-action-trigger/index.md +4 -2
  171. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-date-calculation/index.md +5 -3
  172. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-delay/index.md +4 -2
  173. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-dynamic-calculation/index.md +6 -4
  174. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-javascript/index.md +5 -3
  175. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-json-query/index.md +5 -3
  176. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-json-variable-mapping/index.md +3 -1
  177. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-loop/index.md +4 -2
  178. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-mailer/index.md +5 -3
  179. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-manual/index.md +5 -3
  180. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-notification/index.md +5 -3
  181. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-parallel/index.md +5 -3
  182. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-request/index.md +5 -3
  183. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-request-interceptor/index.md +4 -2
  184. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-response-message/index.md +4 -2
  185. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-sql/index.md +5 -3
  186. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-subflow/index.md +3 -1
  187. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-test/index.md +4 -2
  188. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-transaction/index.md +16 -0
  189. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-variable/index.md +5 -3
  190. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-webhook/index.md +4 -2
  191. package/dist/ai/docs/nocobase/workflow/nodes/index.md +2 -1
  192. package/dist/ai/docs/nocobase/workflow/nodes/transaction.md +81 -0
  193. package/dist/client/561.7ec804ef39ec7dcd.js +10 -0
  194. package/dist/client/{646.b0ed728921b007d4.js → 646.d4483b4ff23da0a0.js} +1 -1
  195. package/dist/client/components/ListCollapse.d.ts +2 -1
  196. package/dist/client/features/components.d.ts +9 -0
  197. package/dist/client/features/feature-manager.d.ts +1 -9
  198. package/dist/client/features/index.d.ts +1 -9
  199. package/dist/client/features/vector-database-provider.d.ts +1 -10
  200. package/dist/client/features/vector-store-provider.d.ts +9 -0
  201. package/dist/client/index.d.ts +1 -0
  202. package/dist/client/index.js +2 -2
  203. package/dist/client/manager/ai-feature-manager.d.ts +1 -6
  204. package/dist/client-v2/features/components.d.ts +14 -0
  205. package/dist/client-v2/features/feature-manager.d.ts +19 -0
  206. package/dist/client-v2/features/index.d.ts +22 -0
  207. package/dist/client-v2/features/vector-database-provider.d.ts +18 -0
  208. package/dist/client-v2/features/vector-store-provider.d.ts +38 -0
  209. package/dist/client-v2/index.d.ts +5 -0
  210. package/dist/client-v2/index.js +1 -1
  211. package/dist/client-v2/manager/ai-feature-manager.d.ts +15 -0
  212. package/dist/externalVersion.js +17 -17
  213. package/dist/node_modules/@langchain/xai/package.json +1 -1
  214. package/dist/node_modules/fs-extra/package.json +1 -1
  215. package/dist/node_modules/jsonrepair/package.json +1 -1
  216. package/dist/node_modules/just-bash/package.json +1 -1
  217. package/dist/node_modules/nodejs-snowflake/package.json +1 -1
  218. package/dist/node_modules/openai/package.json +1 -1
  219. package/dist/node_modules/zod/package.json +1 -1
  220. package/dist/server/ai-employees/ai-knowledge-base.js +1 -1
  221. package/dist/server/features/feature-manager.d.ts +2 -2
  222. package/dist/server/features/vector-store-provider.d.ts +1 -0
  223. package/dist/server/llm-providers/dashscope.js +2 -2
  224. package/dist/server/llm-providers/kimi/provider.js +2 -2
  225. package/dist/server/llm-providers/mimo.js +2 -2
  226. package/dist/server/llm-providers/openai/completions.js +2 -2
  227. package/dist/server/llm-providers/openai/responses.js +8 -4
  228. package/dist/server/llm-providers/provider.d.ts +2 -2
  229. package/dist/server/llm-providers/provider.js +1 -0
  230. package/dist/server/types/knowledge-base.type.d.ts +1 -1
  231. package/dist/server/workflow/nodes/llm/index.js +3 -0
  232. package/package.json +3 -2
  233. package/dist/client/561.776886c5308e3c26.js +0 -10
  234. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/cli-design/nb-app-design-intent.md +0 -0
  235. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/cli-design/nb-proxy-design-intent.md +0 -0
  236. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/airgap.md +0 -0
  237. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/docker-compose.md +0 -0
  238. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/operations/backup-restore.md +0 -0
  239. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/operations/manage-app.md +0 -0
  240. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/operations/multi-environment.md +0 -0
  241. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/plugins/third-party.md +0 -0
  242. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/autostart.md +0 -0
  243. /package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/release-management.md +0 -0
@@ -27,7 +27,7 @@ If the prerequisites are not met, tell the user they need to install the missing
27
27
  If the user already has NocoBase CLI installed (run `nb --version` to check), proceed to the next step. If not, run the following command to install:
28
28
 
29
29
  ```bash
30
- npm install -g @nocobase/cli@beta
30
+ npm install -g @nocobase/cli
31
31
  ```
32
32
 
33
33
  Run `nb --version` to confirm successful installation.
@@ -63,7 +63,7 @@ Before starting, make sure you have the following environment ready:
63
63
 
64
64
  - Claude Code installed (`npm install -g @anthropic-ai/claude-code`)
65
65
  - Node.js >= 22 (for running NocoBase CLI and Skills)
66
- - If you already have a NocoBase instance, **AI capabilities are evolving rapidly and only the latest beta version provides the full experience. Minimum version >= 2.1.0-beta.20, latest version strongly recommended.**
66
+ - If you already have a NocoBase instance, **AI capabilities are evolving rapidly. The minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
67
67
 
68
68
  ## Quick Start
69
69
 
@@ -78,7 +78,7 @@ Help me install NocoBase CLI and complete initialization: https://docs.nocobase.
78
78
  ### Manual Installation
79
79
 
80
80
  ```bash
81
- npm install -g @nocobase/cli@beta
81
+ npm install -g @nocobase/cli
82
82
  nb init --ui
83
83
  ```
84
84
 
@@ -61,7 +61,7 @@ Before starting, make sure you have the following environment ready:
61
61
 
62
62
  - Codex installed (`npm install -g @openai/codex`)
63
63
  - Node.js >= 22 (for running NocoBase CLI and Skills)
64
- - If you already have a NocoBase instance, **AI capabilities are evolving rapidly and only the latest beta version provides the full experience. Minimum version >= 2.1.0-beta.20, latest version strongly recommended.**
64
+ - If you already have a NocoBase instance, **AI capabilities are evolving rapidly. The minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
65
65
 
66
66
  ## Quick Start
67
67
 
@@ -76,7 +76,7 @@ Help me install NocoBase CLI and complete initialization: https://docs.nocobase.
76
76
  ### Manual Installation
77
77
 
78
78
  ```bash
79
- npm install -g @nocobase/cli@beta
79
+ npm install -g @nocobase/cli
80
80
  nb init --ui
81
81
  ```
82
82
 
@@ -69,7 +69,7 @@ Before starting, make sure you have the following environment ready:
69
69
 
70
70
  - A server running Hermes Agent (Linux / macOS, Python 3.10+)
71
71
  - Node.js >= 22 (for running NocoBase CLI and Skills)
72
- - If you already have a NocoBase instance, **AI capabilities are evolving rapidly and only the latest beta version provides the full experience. Minimum version >= 2.1.0-beta.20, latest version strongly recommended.**
72
+ - If you already have a NocoBase instance, **AI capabilities are evolving rapidly. The minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
73
73
 
74
74
  Installing Hermes requires just one command:
75
75
 
@@ -96,7 +96,7 @@ Help me install NocoBase CLI and complete initialization: https://docs.nocobase.
96
96
  ### Manual Installation
97
97
 
98
98
  ```bash
99
- npm install -g @nocobase/cli@beta
99
+ npm install -g @nocobase/cli
100
100
  nb init --ui
101
101
  ```
102
102
 
@@ -92,7 +92,7 @@ features:
92
92
  items:
93
93
  - title: NocoBase CLI
94
94
  details: The command-line tool for NocoBase — install and you're ready to go, with built-in AI Skills that let your AI assistant directly operate NocoBase.
95
- link: /api/cli/
95
+ link: /nocobase-cli/
96
96
  - title: NocoBase Skills
97
97
  details: Domain knowledge packages installable into AI Agents, enabling AI to understand NocoBase's capabilities and conventions.
98
98
  link: /ai-builder#nocobase-skills
@@ -0,0 +1,117 @@
1
+ ---
2
+ title: Install NocoBase App
3
+ description: Install NocoBase CLI and quickly create a new NocoBase application with `nb init --ui`, so your AI Agent can start working right away.
4
+ ---
5
+
6
+ # Install NocoBase App
7
+
8
+ ## Prerequisites
9
+
10
+ - Node.js >= 22
11
+ - Yarn 1.x
12
+ - If you plan to install with Docker, make sure Docker is already running
13
+
14
+ ## Step 1: Install CLI
15
+
16
+ Install NocoBase CLI globally first:
17
+
18
+ ```bash
19
+ npm install -g @nocobase/cli
20
+ nb --version
21
+ ```
22
+
23
+ If you often work with multiple terminals or want to operate in parallel with AI Agents, we also recommend running `nb session setup` once. This lets each session keep its own `current env`, so they are less likely to affect one another.
24
+
25
+ ## Step 2: Initialize the app
26
+
27
+ We recommend installing through the UI wizard:
28
+
29
+ ```bash
30
+ nb init --ui
31
+ ```
32
+
33
+ 1. `Getting started` - set the `--env` identifier and choose `Install a new app`
34
+
35
+ ![2026-06-11-20-14-32](https://static-docs.nocobase.com/2026-06-11-20-14-32.png)
36
+
37
+ 2. `App environment` - set the app basics, storage location, and runtime port
38
+
39
+ ![2026-06-14-10-03-06](https://static-docs.nocobase.com/2026-06-14-10-03-06.png)
40
+
41
+ 3. `App source and version` - choose how to get the app and which source and version to use
42
+
43
+ ![2026-06-14-09-51-33](https://static-docs.nocobase.com/2026-06-14-09-51-33.png)
44
+
45
+ 4. `Configure the database` - choose the built-in database or a custom database
46
+
47
+ ![2026-06-14-09-52-05](https://static-docs.nocobase.com/2026-06-14-09-52-05.png)
48
+
49
+ 5. `Create an admin account` - set up the first admin account
50
+
51
+ ![2026-06-14-09-52-56](https://static-docs.nocobase.com/2026-06-14-09-52-56.png)
52
+
53
+ 6. `Connection & authentication` - enter the app access URL and choose an authentication method
54
+
55
+ ![2026-06-14-10-00-35](https://static-docs.nocobase.com/2026-06-14-10-00-35.png)
56
+
57
+ If you prefer terminal interaction, you can also run:
58
+
59
+ ```bash
60
+ nb init
61
+ ```
62
+
63
+ If you need to initialize in scripts or CI, use non-interactive mode:
64
+
65
+ ```bash
66
+ nb init --yes --env app1
67
+ ```
68
+
69
+ :::tip Install on a remote server
70
+
71
+ If you run `nb init --ui` on a server, we recommend changing the default host to that server's IP first. That way, you can open the wizard from your local browser.
72
+
73
+ ```bash
74
+ nb config set default-ui-host <server-ip>
75
+ nb config set default-api-host <server-ip>
76
+ ```
77
+
78
+ :::
79
+
80
+ ## Step 3: Confirm the app is ready
81
+
82
+ After installation, it is usually worth confirming these three things first:
83
+
84
+ - The env has been saved successfully
85
+ - The app has started normally
86
+ - You can sign in with the administrator account
87
+
88
+ Common commands:
89
+
90
+ ```bash
91
+ nb env list
92
+ nb env info
93
+ nb app logs
94
+ ```
95
+
96
+ For a local default installation, you can usually open `http://localhost:13000` in your browser directly. After signing in, start a new AI Agent session or restart the current one, and the AI can begin working with this NocoBase app.
97
+
98
+ CLI configuration is stored in `~/.nocobase/` by default, so AI Agents can usually access it from any working directory.
99
+
100
+ If this app will be exposed to real users later, we do not recommend using `IP + port` for the long term. The next step is usually to put it behind a reverse proxy and enable HTTPS.
101
+
102
+ ## Next Steps
103
+
104
+ - If you already have a running NocoBase app, see [AI Agent Integration Guide](./quick-start.mdx)
105
+ - If you want to manage app startup, shutdown, logs, and upgrades, see [Manage apps](../nocobase-cli/operations/manage-app.md)
106
+ - If you want to continue with production deployment, see [Install apps with CLI](../nocobase-cli/installation/cli.md) and [Production deployment overview](../nocobase-cli/production/index.md)
107
+ - If you want AI to start building apps, see [AI Builder](../ai-builder/index.md)
108
+
109
+ ## Related Links
110
+
111
+ - [Installation and Version Comparison](../get-started/quickstart.md) — Compare installation methods and version channels first, then decide how to install
112
+ - [AI Agent Integration Guide](./quick-start.mdx) — Connect an existing NocoBase app and let your AI Agent start working
113
+ - [`nb init` command reference](../api/cli/init.md) — Initialize a new app, take over an existing local app, or connect a remote app
114
+ - [`nb env info` command reference](../api/cli/env/info.md) — View the connection details and runtime configuration of the current env
115
+ - [NocoBase CLI](../api/cli/index.md) — Full reference for all `nb` commands
116
+ - [Manage apps](../nocobase-cli/operations/manage-app.md) — Start, stop, restart, view logs, and upgrade apps
117
+ - [Multiple environment management](../nocobase-cli/operations/multi-environment.md) — Common operations when you maintain multiple envs at the same time
@@ -0,0 +1,94 @@
1
+ ---
2
+ title: Local Development Setup
3
+ description: Prepare the local operating system environment for NocoBase CLI and NocoBase apps, covering Windows WSL, macOS, Linux, Node.js, Yarn, and Docker.
4
+ ---
5
+
6
+ # Local Development Setup
7
+
8
+ This page helps you prepare a local environment for NocoBase CLI and NocoBase apps. It is intended for local development, feature evaluation, and AI Agents installing or managing NocoBase on your computer.
9
+
10
+ For real user-facing deployment, see [Production system requirements](../get-started/system-requirements.md).
11
+
12
+ ## Windows: Use WSL
13
+
14
+ For local setup on Windows, we recommend keeping the main development environment inside WSL 2: install Node.js, Yarn, and NocoBase CLI in the Linux distribution in WSL, and run related commands from the WSL terminal.
15
+
16
+ WSL is closer to the Linux environments where NocoBase is commonly deployed. This gives you several benefits:
17
+
18
+ - Dependency installation, build, startup, and log troubleshooting are closer to the actual server workflow
19
+ - After Docker Desktop WSL integration is enabled, you can run `docker` commands directly inside WSL
20
+ - You can avoid extra issues from native Windows path formats, file permissions, symlinks, and native dependency builds
21
+ - It is better for AI Agent workflows. When an agent runs commands such as `nb`, `yarn`, or `docker`, it uses one consistent Linux file path, shell syntax, and runtime environment, which makes troubleshooting more direct
22
+
23
+ If the WSL-based local development environment is not ready yet, see [Set Up a Local Development Environment on Windows with WSL](./windows-wsl.md).
24
+
25
+ Recommended setup:
26
+
27
+ - Windows 10 / 11
28
+ - WSL 2
29
+ - Ubuntu LTS
30
+ - Node.js >= 22
31
+ - Yarn 1.x
32
+ - Docker Desktop, if you plan to install NocoBase with Docker
33
+
34
+ Usually, Node.js, Yarn, and NocoBase CLI should all be installed inside WSL. If you use Docker Desktop, enable WSL integration in Docker Desktop so WSL can access Docker.
35
+
36
+ Check the environment:
37
+
38
+ ```bash
39
+ node -v
40
+ yarn -v
41
+ docker version
42
+ ```
43
+
44
+ :::tip Note
45
+
46
+ NocoBase can also be installed on Windows Server. WSL is recommended here for local development and AI Agent setup on personal computers. It does not mean Windows Server cannot be used for deployment.
47
+
48
+ :::
49
+
50
+ ## macOS
51
+
52
+ On macOS, you can use the local terminal directly.
53
+
54
+ Prepare:
55
+
56
+ - Node.js >= 22
57
+ - Yarn 1.x
58
+ - Docker Desktop, OrbStack, or Colima, if you plan to install NocoBase with Docker
59
+
60
+ Check the environment:
61
+
62
+ ```bash
63
+ node -v
64
+ yarn -v
65
+ docker version
66
+ ```
67
+
68
+ If you do not use Docker, you can skip `docker version`.
69
+
70
+ ## Linux
71
+
72
+ Linux can be used directly as a local development environment. Ubuntu, Debian, or other common distributions are recommended.
73
+
74
+ Prepare:
75
+
76
+ - Node.js >= 22
77
+ - Yarn 1.x
78
+ - Docker Engine, if you plan to install NocoBase with Docker
79
+
80
+ Check the environment:
81
+
82
+ ```bash
83
+ node -v
84
+ yarn -v
85
+ docker version
86
+ ```
87
+
88
+ If you do not use Docker, you can skip `docker version`.
89
+
90
+ ## Next Steps
91
+
92
+ - [Installation and Version Comparison](../get-started/quickstart.md) — Compare installation methods and version channels first
93
+ - [Install NocoBase App](./install-nocobase-app.md) — Initialize a local app with NocoBase CLI
94
+ - [AI Agent Integration Guide](./quick-start.mdx) — Let an AI Agent connect to and operate NocoBase
@@ -63,7 +63,7 @@ Before starting, make sure you have the following environment ready:
63
63
 
64
64
  - A deployed OpenClaw Agent ([one-click Lark deployment](https://openclaw.feishu.cn) or local deployment)
65
65
  - Node.js >= 22 (for running NocoBase CLI and Skills)
66
- - If you already have a NocoBase instance, **AI capabilities are evolving rapidly and only the latest beta version provides the full experience. Minimum version >= 2.1.0-beta.20, latest version strongly recommended.**
66
+ - If you already have a NocoBase instance, **AI capabilities are evolving rapidly. The minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
67
67
 
68
68
  :::warning Note
69
69
 
@@ -84,7 +84,7 @@ Help me install NocoBase CLI and complete initialization: https://docs.nocobase.
84
84
  ### Manual Installation
85
85
 
86
86
  ```bash
87
- npm install -g @nocobase/cli@beta
87
+ npm install -g @nocobase/cli
88
88
  nb init --ui
89
89
  ```
90
90
 
@@ -63,7 +63,7 @@ Before starting, make sure you have the following environment ready:
63
63
 
64
64
  - OpenCode installed ([installation guide](https://opencode.ai/docs/))
65
65
  - Node.js >= 22 (for running NocoBase CLI and Skills)
66
- - If you already have a NocoBase instance, **AI capabilities are evolving rapidly and only the latest beta version provides the full experience. Minimum version >= 2.1.0-beta.20, latest version strongly recommended.**
66
+ - If you already have a NocoBase instance, **AI capabilities are evolving rapidly. The minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
67
67
 
68
68
  ## Quick Start
69
69
 
@@ -78,7 +78,7 @@ Help me install NocoBase CLI and complete initialization: https://docs.nocobase.
78
78
  ### Manual Installation
79
79
 
80
80
  ```bash
81
- npm install -g @nocobase/cli@beta
81
+ npm install -g @nocobase/cli
82
82
  nb init --ui
83
83
  ```
84
84
 
@@ -2,7 +2,6 @@
2
2
  title: "AI Agent Integration Guide"
3
3
  description: "Install NocoBase CLI, connect to or install a NocoBase application, and let AI Agents start operating your business system."
4
4
  keywords: "NocoBase CLI,AI Agent,integration,connect,installation,Skills,quick start"
5
- sidebar: false
6
5
  ---
7
6
 
8
7
  # AI Agent Integration Guide
@@ -42,7 +41,7 @@ If you don't have a NocoBase application yet, you can use CLI to install and ini
42
41
  #### Step 1: Install CLI
43
42
 
44
43
  ```bash
45
- npm install -g @nocobase/cli@beta
44
+ npm install -g @nocobase/cli
46
45
  nb --version // Confirm successful installation
47
46
  ```
48
47
 
@@ -58,15 +57,16 @@ Configuration files and application data are stored in your home directory by de
58
57
 
59
58
  :::
60
59
 
61
- The browser will automatically open a visual configuration page, guiding you through 5 steps:
60
+ The browser will automatically open a visual configuration page, guiding you through 6 steps:
62
61
 
63
- 1. **Start Configuration**Set the application name (also used as the CLI environment name), select "Fresh Installation"
64
- 2. **Create Application**Choose the installation method (Docker / npm / Git), set port and other basic configurations
65
- 3. **Download Application Files**Select source and version, download NocoBase source code or image
66
- 4. **Configure Database** — Use the built-in database or configure an external database (PostgreSQL, MySQL, MariaDB)
67
- 5. **Create Admin Account** — Set the admin email and password
62
+ 1. "Getting started"Choose whether to install a new app, manage a local app, or connect a remote app.
63
+ 2. "App environment"Set the app basics, storage location, and runtime port.
64
+ 3. "App source and version" Choose how to get the app and which source and version to use.
65
+ 4. "Configure the database" — Use built-in or custom.
66
+ 5. "Create an admin account" — Set up the first admin.
67
+ 6. "Connection & authentication" — Enter the app access URL and choose an authentication method.
68
68
 
69
- ![nocobase cli visual wizard](https://static-docs.nocobase.com/2026-04-29-15-55-19.png)
69
+ ![nocobase cli visual wizard](https://static-docs.nocobase.com/2026-06-11-20-14-32.png)
70
70
 
71
71
  After installation is complete, open your browser and visit `http://localhost:13000` (default port), then log in with the admin account you just set up.
72
72
 
@@ -92,7 +92,7 @@ After configuration is complete, restart your AI Agent session and you can start
92
92
 
93
93
  ## Connect AI Agent to an Existing NocoBase
94
94
 
95
- If you already have a running NocoBase instance, you can connect AI Agent to it directly. **Since AI capabilities are evolving rapidly, only the latest beta version provides the full experience. The minimum required version is 2.1.0-beta.20 we strongly recommend updating to the latest.**
95
+ If you already have a running NocoBase instance, you can connect AI Agent to it directly. **Since AI capabilities are evolving rapidly, the minimum required version is NocoBase 2.1.0, and we recommend updating to the latest version.**
96
96
 
97
97
  <Tabs>
98
98
  <Tab label="Manual Connection" value="manual-connect">
@@ -100,7 +100,7 @@ If you already have a running NocoBase instance, you can connect AI Agent to it
100
100
  #### Step 1: Install CLI
101
101
 
102
102
  ```bash
103
- npm install -g @nocobase/cli@beta
103
+ npm install -g @nocobase/cli
104
104
  nb --version // Confirm successful installation
105
105
  ```
106
106
 
@@ -116,12 +116,12 @@ Configuration files are stored in your home directory by default. See [NB_CLI_RO
116
116
 
117
117
  :::
118
118
 
119
- The browser will automatically open a visual configuration page. In the first step "Start Configuration", select "Connect to Existing Application", then:
119
+ The browser will automatically open a visual configuration page. In the first step "Start Configuration", select "Remote Connection", then:
120
120
 
121
121
  1. **Enter API Address** — Input the API address of your existing NocoBase instance (e.g., `http://localhost:13000/api`)
122
122
  2. **Select Authentication Method** — Choose an [authentication method](../ai-builder/security) (OAuth is recommended for quick setup)
123
123
 
124
- ![nocobase cli visual wizard](https://static-docs.nocobase.com/2026-04-29-15-55-55.png)
124
+ ![nocobase cli visual wizard](https://static-docs.nocobase.com/2026-06-11-21-18-31.png)
125
125
 
126
126
  No need to configure installation method, database, or admin account — the wizard will skip those steps.
127
127
 
@@ -132,7 +132,7 @@ Start a new or restart the AI Agent session, and you can let the AI Agent start
132
132
  </Tab>
133
133
  <Tab label="Connect with AI Agent" value="ai-connect">
134
134
 
135
- Copy the prompt below to your AI assistant. It will complete CLI installation and guide you through connecting to your existing NocoBase instance. Select "Connect to Existing Application" in the first step of the visual wizard:
135
+ Copy the prompt below to your AI assistant. It will complete CLI installation and guide you through connecting to your existing NocoBase instance. Select "Remote Connection" in the first step of the visual wizard:
136
136
 
137
137
  ```
138
138
  Help me install NocoBase CLI and complete initialization: https://docs.nocobase.com/ai/ai-quick-start.md (please read the linked content directly)
@@ -145,6 +145,13 @@ After configuration is complete, restart your AI Agent session and you can start
145
145
 
146
146
  ## What's Next
147
147
 
148
+ ### Production Installation and Deployment
149
+
150
+ If you're preparing to deploy NocoBase to production, this order usually works best:
151
+
152
+ 1. [Install using CLI](../nocobase-cli/installation/cli.md) - the complete installation flow. This is the right place when you want to install CLI from scratch, initialize env, and confirm the app is already running on your server
153
+ 2. [Production deployment overview](../nocobase-cli/production/index.md) - the next step after the app is running. This mainly covers autostart, reverse proxy, domain setup, and HTTPS
154
+
148
155
  ### Manage Application Environments
149
156
 
150
157
  If you need to manage existing NocoBase instances (such as test or production environments), or switch between multiple environments, see [Environment Management](../ai-builder/env-bootstrap) — covering environment checks, adding environments, upgrades, and troubleshooting.
@@ -172,4 +179,4 @@ If you already have a NocoBase application running, or have successfully complet
172
179
  - [AI Employees](../ai-employees/index.md) — Collaborate with AI in the business interface
173
180
  - [Environment Management](../ai-builder/env-bootstrap) — Environment checks, adding environments, upgrades, and troubleshooting
174
181
  - [NocoBase CLI Command Reference](../api/cli/index.md) — Full parameter documentation for all commands
175
- - [Installation Methods and Version Comparison](../get-started/quickstart) — Different installation methods and version channels for NocoBase
182
+ - [Installation Methods and Version Comparison](../ai/quickstart) — Different installation methods and version channels for NocoBase
@@ -0,0 +1,57 @@
1
+ ---
2
+ title: NocoBase 2.0 to 2.1 Upgrade Guide
3
+ description: Upgrade a NocoBase 2.0 app to 2.1, including old installation methods, nb CLI options, and the recommended migration path.
4
+ ---
5
+
6
+ # How to Upgrade NocoBase from 2.0 to 2.1
7
+
8
+ Upgrading from NocoBase 2.0 to NocoBase 2.1 is smooth for the app itself. The bigger change is the NocoBase CLI.
9
+
10
+ Where:
11
+
12
+ - In 2.0 and earlier, CLI commands usually start with `yarn nocobase`
13
+ - In 2.1 and later, CLI commands use the globally installed `nb`
14
+
15
+ Old apps do not have to move to `nb` right away. If you only need to upgrade an already stable NocoBase 2.0 app to 2.1, continue using the original installation and upgrade method by default. For newly installed apps, we recommend using the new `nb` CLI.
16
+
17
+ ## Continue Using the Original Installation and Upgrade Method
18
+
19
+ If you are already used to the previous installation method, you can keep using it. Follow the original installation and upgrade docs as before.
20
+
21
+ ### Install NocoBase
22
+
23
+ - [Docker installation](/get-started/installation/docker)
24
+ - [create-nocobase-app installation](/get-started/installation/create-nocobase-app)
25
+ - [Git source installation](/get-started/installation/git)
26
+
27
+ ### Upgrade NocoBase
28
+
29
+ - [Upgrade a Docker installation](/get-started/upgrading/docker)
30
+ - [Upgrade a create-nocobase-app installation](/get-started/upgrading/create-nocobase-app)
31
+ - [Upgrade a Git source installation](/get-started/upgrading/git)
32
+
33
+ ## Use `nb` CLI for New Apps
34
+
35
+ For new apps, we recommend the more convenient `nb` installation and upgrade flow.
36
+
37
+ ### Install NocoBase
38
+
39
+ - [Install NocoBase App](./install-nocobase-app.md)
40
+
41
+ ### Upgrade NocoBase
42
+
43
+ - [Upgrade NocoBase App](./upgrade-nocobase-app.md)
44
+
45
+ ## How to Migrate to `nb` CLI
46
+
47
+ If you want to manage apps with `nb` consistently in the future, the more reliable approach for now is to create a new app and migrate the old app data into it.
48
+
49
+ Migration steps:
50
+
51
+ 1. Create a new CLI app with `nb init`
52
+ 2. Migrate the old app's database, `storage`, and required environment variables
53
+ 3. After verifying that the new app works properly, switch the production environment over to it
54
+
55
+ You can also wait for a while. The ability for `nb` to take over existing local apps is still under development.
56
+
57
+ ![2026-06-13-21-29-24](https://static-docs.nocobase.com/2026-06-13-21-29-24.png)
@@ -0,0 +1,111 @@
1
+ ---
2
+ title: Upgrade NocoBase App
3
+ description: Upgrade a NocoBase app saved as a CLI env with nb app upgrade, including env confirmation, upgrade commands, target versions, and verification.
4
+ ---
5
+
6
+ # Upgrade NocoBase App
7
+
8
+ :::tip Scope
9
+
10
+ This guide applies to apps installed with `nb init`. If your app was installed with the old method, read [How to upgrade NocoBase from 2.0 to 2.1](./upgrade-from-2-0-to-2-1.md) first.
11
+
12
+ :::
13
+
14
+ ## Step 1: Confirm the Current Env
15
+
16
+ ```bash
17
+ nb env current
18
+ ```
19
+
20
+ If you are not sure which envs are available, list them first:
21
+
22
+ ```bash
23
+ nb env list
24
+ ```
25
+
26
+ If the current env is not the app you want to upgrade, switch to the target env:
27
+
28
+ ```bash
29
+ nb env use <env-name>
30
+ ```
31
+
32
+ ## Step 2: Run the Upgrade
33
+
34
+ :::warning Note
35
+
36
+ By default, upgrade downloads the app source code or Docker image again.
37
+
38
+ For npm / Git envs, the `source/` directory is deleted and downloaded again. Do not put files you need to keep in `source/`.
39
+
40
+ If you have already prepared the source code or Docker image manually and do not want CLI to download it again, add `--skip-download` after the command.
41
+
42
+ :::
43
+
44
+ The default upgrade command is:
45
+
46
+ ```bash
47
+ nb app upgrade
48
+ ```
49
+
50
+ This command usually completes these steps:
51
+
52
+ 1. Stop the current app
53
+ 2. Download and replace the saved source or image
54
+ 3. Sync commercial plugins
55
+ 4. Upgrade and start the app
56
+ 5. Refresh env runtime information
57
+
58
+ In scripts, CI, or AI Agent sessions, pass `--force` explicitly:
59
+
60
+ ```bash
61
+ nb app upgrade --force
62
+ ```
63
+
64
+ If the app to upgrade is not the current env, specify the env:
65
+
66
+ ```bash
67
+ nb app upgrade --env app1 --yes --force
68
+ ```
69
+
70
+ ### Upgrade to a Specific Version
71
+
72
+ Use `--version` to upgrade to a specific version channel:
73
+
74
+ ```bash
75
+ nb app upgrade --version beta
76
+ ```
77
+
78
+ You can also pass an exact version:
79
+
80
+ ```bash
81
+ nb app upgrade --version 2.1.0-beta.24
82
+ ```
83
+
84
+ After a successful upgrade, CLI writes the target version back to the env configuration, so later upgrades or recovery flows can reuse it.
85
+
86
+ ### Skip Download
87
+
88
+ If you have already updated the source code or Docker image, and only want to run upgrade and start based on the current content, add `--skip-download`:
89
+
90
+ ```bash
91
+ nb app upgrade --skip-download
92
+ ```
93
+
94
+ This skips source or image download and also skips commercial plugin sync. Use it only when the target version has already been prepared manually.
95
+
96
+ ## Step 3: Verify the Result
97
+
98
+ After the upgrade, check env runtime and app logs:
99
+
100
+ ```bash
101
+ nb env info
102
+ nb app logs
103
+ ```
104
+
105
+ Then open the app and confirm that the administrator account can sign in. If you want an AI Agent to continue working with this app, start a new AI Agent session or restart the current one so it can read the latest env information.
106
+
107
+ ## Related Links
108
+
109
+ - [Manage apps](../nocobase-cli/operations/manage-app.md) — Start, stop, restart, view logs, and upgrade apps
110
+ - [`nb app upgrade` command reference](../api/cli/app/upgrade.md) — View all upgrade command options
111
+ - [Multiple environment management](../nocobase-cli/operations/multi-environment.md) — Confirm, switch, and maintain multiple CLI envs