Skip to main content

Quick Start

Welcome to CloudBase AI ToolKit! Describe your requirements in natural language, and AI will automatically generate the code and deploy it to the Tencent Cloud Development Platform.

GitHub Stars CNB Community

🌟 Core Capabilities​

  • 🤖 AI-Powered Intelligent Development: Automatically generate code and architecture design.
  • ☁️ Cloud Development Integration: One-click access to databases, cloud functions, and static hosting.
  • 🚀 Rapid Deployment: Deploy full-stack applications within minutes.
  • 📱 Full-Stack Support: Web + Mini Program + Backend Integration
  • 🔧 Intelligent Repair: AI automatically views logs and fixes issues.

🎯 Applicable Scenarios​

Rapid prototyping, learning and practice, business development, Mini Program development

🚀 Step 1: Select Your AI Development Tool​

Select the AI development tool you are currently using or plan to use, and click to view the detailed configuration guide:

ToolSupported PlatformView Guide
CursorStandalone IDEView Guide
WindSurfStandalone IDE, VSCode plugin, JetBrains pluginView Guide
CodeBuddyVS Code, JetBrains, WeChat DevTools, Standalone IDE (Recommended, with CloudBase AI Toolkit built-in)View Guide
CLINEVS Code pluginView Guide
GitHub CopilotVS Code pluginView Guide
TraeStandalone IDEView Guide
Tongyi LingmaStandalone IDE, VS Code plugin, JetBrains pluginView Guide
RooCodeVS Code pluginView Guide
Baidu ComateVS Code plugin, JetBrains pluginView Guide
Augment CodeVS Code, JetBrains pluginView Guide
Claude CodeCommand-line toolView Guide
Gemini CLICommand-line toolView Guide
OpenAI Codex CLICommand-line toolView Guide
OpenCodeCommand-line toolView Guide
Qwen CodeCommand-line toolView Guide

Quick Configuration (General)​

If your tool does not have a dedicated guide yet, you can use the following general MCP configuration:

{
  "mcpServers": {
    "cloudbase": {
      "command": "npx",
      "args": ["npm-global-exec@latest", "@cloudbase/cloudbase-mcp@latest"]
    }
  }
}

After completing the configuration, enter the following content in the AI chat for verification:

Check if the CloudBase tool is available

✅ Step 2: Verify Environment​

Prerequisites Check​

✅ Node.js v18.15.0+ installed

Ensure Node.js v18.15.0 or above is installed on your computer. Check the version:

node --version

If not installed, please download and install it from the Node.js official website.

☁️ Activate Cloud Development Environment

Visit the Tencent CloudBase console to activate an environment (free for new users).

🚀 Optional: Acceleration Configuration

Set npm Mirror Registry (to improve download speed):

npm config set registry https://mirrors.cloud.tencent.com/npm/

Clear npx Cache (to avoid installation issues):

npx clear-npx-cache

🎯 Step 3: Select Project Template​

📦 Use pre-built templates (Recommended for beginners)​

We have prepared project templates with various tech stacks for you, featuring built-in CloudBase best practices and AI rules:

  • 📱 WeChat Mini Program + Cloud Development
  • ⚛️ React Web + Cloud Development
  • 💚 Vue Web + Cloud Development
  • 🦄 UniApp Cross-platform Application + Cloud Development
  • 🛠️ Universal Template (Suitable for any tech stack)

👉 View All Project Templates

After selecting the appropriate template, simply tell the AI:

Download [Template Name] to the current directory

If you only want to download configuration files for a specific IDE to avoid cluttering your project files, you can specify the IDE type:

Download the Mini Program CloudBase template with only the Cursor configuration
Download the React CloudBase template with only the WindSurf configuration
Download the universal Cloud Development template containing only the Claude Code configuration

🔧 Enhance Existing Projects​

If you already have a project, simply tell the AI:

Download CloudBase AI rules in the current project

AI will automatically download and configure CloudBase rules in your project. It also supports specifying the IDE type:

Download CloudBase AI rules in the current project, with only the Cursor configuration
Download CloudBase AI rules in the current project, containing only the WindSurf configuration

🔐 Step 4: Log in to CloudBase​

In the AI conversation, enter:

Log in to CloudBase

AI will automatically:

  • Pop up the Tencent Cloud login interface
  • Display available CloudBase environments
  • Complete environment selection and configuration

Verify Login Status​

Query current CloudBase environment information

🚀 Step 5: Start Development​

Now you can describe your requirements in natural language to have the AI develop applications for you:

Example Requirement​

Help me create a to-do application with:
- Add, delete, and edit to-do items
- Store data to cloud database
- Support marking completion status
- Deploy to the cloud
Creating a simple blog system requires:
- Article list page
- Article detail page  
- Article publishing feature
- Store data to cloud database

💡 Development Tips​

  • Detailed description: The more detailed the requirements description, the more accurate the code generated by AI
  • Incremental Development: Features can be added gradually, such as implementing basic functionality first, then adding advanced features
  • Error Handling: When encountering issues, provide the complete error information to the AI
  • Log Debugging: You can request the AI to view cloud function logs for troubleshooting

🎯 Typical Development Workflow​

🔧 Debugging and Issue Resolution​

When Encountering Errors​

An error occurred. The error message is: [paste complete error message]

Cloud Function Debugging​

The cloud function is running abnormally. The requirement is [describe the original requirement]. Please check the logs to debug and fix the issue.

Environment Switching​

If you need to switch the CloudBase environment:

Log out of CloudBase

Then log in again and select a different environment.

🎉 Complete! You are ready​

✅ AI development tool has been configured
✅ CloudBase environment is connected
✅ Project template is ready
✅ Development workflow is understood

Start describing your application requirements in natural language now, and let the AI help you quickly build full-stack applications!

📚 Advanced Learning​

💫 If this project is helpful to you, we welcome you to give us a ⭐ Star!

GitHub CNB