Plugins

CloudBase Framework supports a plugin mechanism and provides plugins for various application frameworks and cloud resources.

Plugins can handle processes such as build, deployment, development, and debugging for independent units in applications. For example, the website plugin can handle units like static websites, and the node plugin can handle node applications such as koa and express.

The plugin configuration is written in the cloudbaserc.json file. For details, please refer to the configuration instructions. Plugin configuration can be filled in manually or generated automatically.

Currently, automatic configuration generation is supported for some frameworks/languages.

Auto-detection and Generation of Plugin Configuration

You can run the cloudbase command in the project directory to automatically detect, generate plugin configuration files, and deploy.

cloudbase


✔ Do you want to deploy the current project <Projects/test/test-vue> using CloudBase? (Y/n) · true
✔ Select associated environment · webpage - [webpage: Pay-As-You-Go Billing]
   ______ __                   __ ____
  / ____// /____   __  __ ____/ // __ ) ____ _ _____ ___
 / /    / // __ \ / / / // __  // __  |/ __ `// ___// _ \
/ /___ / // /_/ // /_/ // /_/ // /_/ // /_/ /(__  )/  __/
\_________\____/ \__,_/ \__,_//_____/ \__,_//____/ \___/       __
   / ____/_____ ____ _ ____ ___   ___  _      __ ____   _____ / /__
  / /_   / ___// __ `// __ `__ \ / _ \| | /| / // __ \ / ___// //_/
 / __/  / /   / /_/ // / / / / //  __/| |/ |/ // /_/ // /   / ,<
/_/    /_/    \__,_//_/ /_/ /_/ \___/ |__/|__/ \____//_/   /_/|_|


 CloudBase Framework  info     Version v1.2.10
 CloudBase Framework  info     Github: https://github.com/Tencent/cloudbase-framework

 CloudBase Framework  info     EnvId webpage
? Vue.js project detected in the current directory

  🔨 Build script `npm run build`
  📦 Local static file directory `dist`

  Whether to modify the default configuration No
? Enter application unique identifier (supports uppercase/lowercase letters, numbers, and hyphens; must be unique within the same account): test-vue
? Do you want to save the current project configuration? (This will prevent future prompts) Yes
 CloudBase Framework  info     📦 install plugins

Manual Plugin Configuration

You can refer to the configuration instructions and the corresponding plugin documentation to fill in the configuration.

Example:

{
  "framework": {
    "plugins": {
      "client": {
        "use": "@cloudbase/framework-plugin-website",
        "inputs": {
          "buildCommand": "npm run build",
          "outputPath": "dist",
          "cloudPath": "/vue"
        }
      },
      "server": {
        "use": "@cloudbase/framework-plugin-function",
        "inputs": {
          "functionRootPath": "cloudfunctions",
          "functions": [
            {
              "name": "vue-echo"
            }
          ]
        }
      }
    }
  }
}

Official Plugin List

Plugin Link	Plugin	Latest Version	Description
	@cloudbase/framework-plugin-website		One-click website deployment
	@cloudbase/framework-plugin-node		One-click deployment of Node applications (supports underlying deployment as functions or cloud hosting)
	@cloudbase/framework-plugin-nuxt		One-click deployment of Nuxt SSR applications
	@cloudbase/framework-plugin-function		One-click function deployment
	@cloudbase/framework-plugin-container		One-click cloud hosting container deployment
	@cloudbase/framework-plugin-dart		One-click Dart application deployment
	@cloudbase/framework-plugin-database		One-click declarative deployment of CloudBase NoSQL database
	@cloudbase/framework-plugin-deno		One-click Deno application deployment
	@cloudbase/framework-plugin-next		One-click deployment of Next SSR applications
	@cloudbase/framework-plugin-mp		One-click deployment of WeChat Mini Program applications
	@cloudbase/framework-plugin-auth		One-click login configuration setup