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

package/nocobase-ctl.config.json

@@ -0,0 +1,388 @@
+{
+  "moduleGroups": [
+    {
+      "match": ["workflow*", "@nocobase/plugin-workflow*"],
+      "module": "workflow"
+    },
+    {
+      "match": ["@nocobase/plugin-data-source-main", "@nocobase/plugin-data-source-manager"],
+      "module": "data-modeling"
+    }
+  ],
+  "modules": {
+    "core": {
+      "name": "core",
+      "description": "NocoBase core resource APIs.",
+      "include": true,
+      "resources": {
+        "includes": ["app", "pm"],
+        "excludes": [],
+        "overrides": {
+          "app": {
+            "name": "app",
+            "description": "Application management commands.",
+            "topLevel": true
+          },
+          "pm": {
+            "name": "pm",
+            "description": "Plugin manager commands.",
+            "topLevel": true
+          }
+        }
+      }
+    },
+    "acl": {
+      "name": "acl",
+      "description": "Based on roles, resources, and actions, access control can precisely manage interface configuration permissions, data operation permissions, menu access permissions, and plugin permissions.",
+      "include": true,
+      "resources": {
+        "includes": ["availableActions", "dataSources", "roles", "rolesResourcesScopes", "desktopRoutes"],
+        "excludes": [],
+        "overrides": {
+          "availableActions": {
+            "name": "available-actions",
+            "description": "List and inspect configurable ACL actions.",
+            "topLevel": false
+          },
+          "dataSources": {
+            "name": "data-sources",
+            "description": "Manage ACL strategies for data sources.",
+            "topLevel": false
+          },
+          "roles": {
+            "name": "roles",
+            "description": "Manage roles and role-level ACL settings.",
+            "topLevel": false
+          },
+          "rolesResourcesScopes": {
+            "name": "roles-resources-scopes",
+            "description": "Manage role resource scopes and permissions.",
+            "topLevel": false
+          },
+          "desktopRoutes": {
+            "name": "desktop-routes",
+            "description": "Manage desktop route permissions and visibility.",
+            "topLevel": false,
+            "operations": {
+              "includes": ["desktopRoutes:listAccessible"]
+            }
+          }
+        }
+      }
+    },
+    "api-keys": {
+      "name": "api-keys",
+      "description": "Allow users to access the HTTP API with API keys.",
+      "include": true,
+      "resources": {
+        "includes": ["apiKeys"],
+        "excludes": [],
+        "overrides": {
+          "apiKeys": {
+            "name": "api-keys",
+            "description": "Manage API keys.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "auth": {
+      "name": "authenticators",
+      "description": "User authentication management, including password auth, SMS auth, SSO protocols, and extensible providers.",
+      "include": true,
+      "resources": {
+        "includes": ["authenticators"],
+        "excludes": [],
+        "overrides": {
+          "auth": {
+            "name": "auth",
+            "description": "Authenticate users and manage auth sessions.",
+            "topLevel": false
+          },
+          "authenticators": {
+            "name": "authenticators",
+            "description": "Manage authentication providers and authenticators.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "client": {
+      "name": "client",
+      "description": "Provide the web client interface for the NocoBase server.",
+      "include": true,
+      "resources": {
+        "includes": ["desktopRoutes"],
+        "excludes": [],
+        "overrides": {
+          "desktopRoutes": {
+            "name": "desktop-routes",
+            "description": "Manage desktop route permissions and visibility.",
+            "topLevel": true,
+            "operations": {
+              "excludes": ["desktopRoutes:listAccessible"]
+            }
+          }
+        }
+      }
+    },
+    "data-modeling": {
+      "name": "data-modeling",
+      "description": "Manage data sources, collections, and database modeling resources.",
+      "include": true,
+      "resources": {
+        "includes": ["collections", "fields", "dataSources", "dataSourcesCollections", "dbViews"],
+        "excludes": [],
+        "overrides": {
+          "collections": {
+            "name": "collections",
+            "description": "Manage collections and collection metadata.",
+            "topLevel": false,
+            "operations": {
+              "includes": [
+                "apply",
+                "collections:list",
+                "collections:get",
+                "collections:destroy",
+                "collections/{collectionName}/fields:list"
+              ]
+            }
+          },
+          "fields": {
+            "name": "fields",
+            "description": "Manage fields with the compact high-level modeling interface.",
+            "topLevel": false,
+            "operations": {
+              "includes": ["apply"]
+            }
+          },
+          "dataSources": {
+            "name": "data-sources",
+            "description": "Inspect external data sources and their loaded collection metadata.",
+            "topLevel": false,
+            "operations": {
+              "includes": ["dataSources:listEnabled", "dataSources/{associatedIndex}/collections:list"]
+            }
+          },
+          "dataSourcesCollections": {
+            "name": "data-sources-collections",
+            "description": "Manage external data source collection field metadata.",
+            "topLevel": false,
+            "operations": {
+              "includes": [
+                "dataSourcesCollections/{associatedIndex}/fields:list",
+                "dataSourcesCollections/{associatedIndex}/fields:apply"
+              ]
+            }
+          },
+          "dbViews": {
+            "name": "db-views",
+            "description": "Inspect and query database views.",
+            "topLevel": false,
+            "operations": {
+              "includes": ["dbViews:list", "dbViews:get"]
+            }
+          }
+        }
+      }
+    },
+    "file-manager": {
+      "name": "file-manager",
+      "description": "Provide file storage services, file collections, and attachment fields.",
+      "include": true,
+      "resources": {
+        "includes": ["storages"],
+        "excludes": [],
+        "overrides": {
+          "storages": {
+            "name": "storages",
+            "description": "Manage storage backends and file storage settings.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "flow-engine": {
+      "name": "flow-engine",
+      "description": "Manage flow surface composition, configuration, layout, and mutation APIs.",
+      "include": true,
+      "resources": {
+        "includes": ["flowSurfaces"],
+        "excludes": [],
+        "overrides": {
+          "flowSurfaces": {
+            "name": "flow-surfaces",
+            "description": "Compose and mutate page, tab, block, field, and action surfaces.",
+            "topLevel": true
+          }
+        }
+      }
+    },
+    "map": {
+      "name": "map",
+      "description": "Map blocks with support for AMap, Google Maps, and extensible providers.",
+      "include": true,
+      "resources": {
+        "includes": ["map-configuration"],
+        "excludes": [],
+        "overrides": {
+          "map-configuration": {
+            "name": "map-configuration",
+            "description": "Manage map provider configuration.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "backup": {
+      "name": "backup",
+      "description": "Create, inspect, download, remove, and restore NocoBase backups.",
+      "include": true,
+      "resources": {
+        "includes": ["backup"],
+        "excludes": [],
+        "overrides": {
+          "backup": {
+            "name": "backup",
+            "description": "Manage backup and restore files.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "backup:list",
+                "backup:create",
+                "backup:status",
+                "backup:download",
+                "backup:remove",
+                "backup:restore",
+                "backup:restoreUpload",
+                "backup:restoreStatus"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "migration": {
+      "name": "migration",
+      "description": "Create, check, execute, and inspect migration packages.",
+      "include": true,
+      "resources": {
+        "includes": ["migration", "migrationLog", "migrationRule", "migrationRules"],
+        "excludes": [],
+        "overrides": {
+          "migration": {
+            "name": "migration",
+            "description": "Manage migration files and executions.",
+            "topLevel": true,
+            "operations": {
+              "includes": [
+                "migration:list",
+                "migration:get",
+                "migration:create",
+                "migration:download",
+                "migration:remove",
+                "migration:check",
+                "migration:execute"
+              ]
+            }
+          },
+          "migrationRule": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "Create migration rules with global user/system policies.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRule:create"]
+            }
+          },
+          "migrationRules": {
+            "name": "migration rules",
+            "segments": ["migration", "rules"],
+            "description": "List and inspect migration rules.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationRules:list", "migrationRules:get"]
+            }
+          },
+          "migrationLog": {
+            "name": "migration logs",
+            "segments": ["migration", "logs"],
+            "description": "List, inspect, and download migration logs.",
+            "topLevel": true,
+            "operations": {
+              "includes": ["migrationLog:list", "migrationLog:get", "migrationLog:download"]
+            }
+          }
+        }
+      }
+    },
+    "system-settings": {
+      "name": "system-settings",
+      "description": "Adjust system title, logo, language, and other global settings.",
+      "include": true,
+      "resources": {
+        "includes": ["systemSettings"],
+        "excludes": [],
+        "overrides": {
+          "systemSettings": {
+            "name": "system-settings",
+            "description": "Manage global system settings.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "theme-editor": {
+      "name": "theme-editor",
+      "description": "Customize UI colors and dimensions, save themes, and switch between them.",
+      "include": true,
+      "resources": {
+        "includes": ["themeConfig"],
+        "excludes": [],
+        "overrides": {
+          "themeConfig": {
+            "name": "theme-config",
+            "description": "Manage theme configuration.",
+            "topLevel": false
+          }
+        }
+      }
+    },
+    "workflow": {
+      "name": "workflow",
+      "description": "A powerful BPM tool that provides the foundation for business automation and extensible triggers and nodes.",
+      "include": true,
+      "resources": {
+        "includes": ["executions", "flow_nodes", "jobs", "userWorkflowTasks", "workflows"],
+        "excludes": [],
+        "overrides": {
+          "executions": {
+            "name": "executions",
+            "description": "Manage workflow execution records.",
+            "topLevel": false
+          },
+          "flow_nodes": {
+            "name": "flow-nodes",
+            "description": "Manage workflow nodes.",
+            "topLevel": false
+          },
+          "jobs": {
+            "name": "jobs",
+            "description": "Manage workflow jobs.",
+            "topLevel": false
+          },
+          "userWorkflowTasks": {
+            "name": "user-workflow-tasks",
+            "description": "Query current user workflow tasks.",
+            "topLevel": false
+          },
+          "workflows": {
+            "name": "workflows",
+            "description": "Manage workflows and workflow revisions.",
+            "topLevel": false
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,38 +1,112 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.0-alpha.4",
-  "description": "",
-  "license": "AGPL-3.0",
-  "main": "./src/index.js",
+  "version": "2.1.0-alpha.40",
+  "description": "NocoBase Command Line Tool",
+  "type": "module",
+  "main": "dist/generated/command-registry.js",
+  "scripts": {
+    "clean": "node ./scripts/clean.mjs",
+    "build": "node ./scripts/build.mjs",
+    "test": "yarn cross-env NB_CLI_ROOT=. TEST_ENV=server-side yarn --cwd ../../.. vitest run packages/core/cli/src"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "files": [
+    "bin",
+    "dist",
+    "nocobase-ctl.config.json"
+  ],
   "bin": {
-    "nocobase": "./bin/index.js"
+    "nb": "./bin/run.js"
+  },
+  "oclif": {
+    "bin": "nb",
+    "helpOptions": {
+      "flagSortOrder": "none"
+    },
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "helpClass": "./dist/help/runtime-help.js",
+    "commands": {
+      "strategy": "explicit",
+      "target": "./dist/generated/command-registry.js"
+    },
+    "dirname": "nb",
+    "topicSeparator": " ",
+    "topics": {
+      "app": {
+        "description": "Manage NocoBase app runtimes: start, stop, restart, logs, and upgrades."
+      },
+      "source": {
+        "description": "Work with the local NocoBase source project: download, develop, build, and test."
+      },
+      "scaffold": {
+        "description": "Generate NocoBase plugin development scaffolds."
+      },
+      "plugin": {
+        "description": "Manage plugins in the selected NocoBase env."
+      },
+      "pm": {
+        "description": "Manage plugins in the selected NocoBase env.",
+        "hidden": true
+      },
+      "db": {
+        "description": "Manage the built-in database for the selected env."
+      },
+      "env": {
+        "description": "Manage NocoBase project environments, status, details, and command runtimes."
+      },
+      "license": {
+        "description": "Manage NocoBase commercial licensing and licensed plugins."
+      },
+      "config": {
+        "description": "Manage CLI configuration defaults."
+      },
+      "self": {
+        "description": "Inspect or update the NocoBase CLI itself."
+      },
+      "backup": {
+        "description": "Create and restore NocoBase backups."
+      },
+      "skills": {
+        "description": "Inspect or synchronize NocoBase AI coding skills for the current workspace."
+      },
+      "examples": {
+        "description": "Internal example commands for prompt and UI experiments.",
+        "hidden": true
+      },
+      "api": {
+        "description": "Work with NocoBase API."
+      }
+    }
   },
   "dependencies": {
-    "@nocobase/app": "2.1.0-alpha.4",
-    "@nocobase/license-kit": "^0.3.7",
-    "@types/fs-extra": "^11.0.1",
-    "@umijs/utils": "3.5.20",
-    "chalk": "^4.1.1",
-    "commander": "^9.2.0",
-    "deepmerge": "^4.3.1",
-    "dotenv": "^16.0.0",
-    "execa": "^5.1.1",
-    "fast-glob": "^3.3.1",
-    "fs-extra": "^11.1.1",
-    "p-all": "3.0.0",
-    "pm2": "^6.0.5",
-    "portfinder": "^1.0.28",
-    "tar": "^7.4.3",
-    "tree-kill": "^1.2.2",
-    "tsx": "^4.19.0"
+    "@inquirer/ansi": "^2.0.5",
+    "@inquirer/confirm": "^6.0.13",
+    "@inquirer/core": "^11.1.10",
+    "@inquirer/select": "^5.1.5",
+    "@inquirer/type": "^4.0.5",
+    "@nocobase/license-kit": "^0.3.8",
+    "@oclif/core": "^4.10.4",
+    "cross-spawn": "^7.0.6",
+    "mysql2": "^3.14.0",
+    "openapi-types": "^12.1.3",
+    "ora": "^8.2.0",
+    "pg": "^8.14.1",
+    "picocolors": "^1.1.1",
+    "tar": "^7.5.15"
   },
   "devDependencies": {
-    "@nocobase/devtools": "2.1.0-alpha.4"
+    "@types/node": "^18.19.130",
+    "tsx": "^4.20.6",
+    "typescript": "^6.0.2",
+    "vitest": "^1.5.0"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nocobase/nocobase.git",
-    "directory": "packages/core/cli"
+    "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "32c682485e5f1878b9165be2e9de18000d98f935"
+  "gitHead": "e73f99dd0abefe847f2e50ff0fea1f41a82fd048"
 }