Quick Start

This article introduces how to use CloudBase CLI to quickly manage integration configurations.

What is an Integration

An integration is a capability provided by CloudBase that allows you to bind third-party services or custom business logic to cloud functions, enabling more flexible business scenarios.

Quick Experience

1. Install and Login to CLI

npm install -g @cloudbase/cli
tcb login

2. Create an Integration

# Interactive creation
tcb integration create

# Create with specified name and type
tcb integration create --name my-integration --auth-type custom

3. View Integration List

# View all integrations in the current environment
tcb integration list

# Output in JSON format
tcb integration list --json

4. Bind to Cloud Function

# Bind integration to cloud function
tcb integration bind-resource --key-id key-xxx --function my-function

5. View Integration Details

# Query by Key ID
tcb integration get --key-id key-xxx

# Query by name
tcb integration get --name my-integration

6. Update Integration

# Update integration name and description
tcb integration update --key-id key-xxx --name new-name --description "Updated description"

7. Delete Integration

# Delete specified integration
tcb integration delete --key-id key-xxx

Common Commands

Command	Description
tcb integration create	Create an integration
tcb integration list	Query integration list
tcb integration get	Query integration details
tcb integration update	Update integration configuration
tcb integration bind-resource	Bind to cloud function
tcb integration delete	Delete an integration

Next Steps

• Create Integration - Learn detailed parameters for creating integrations
• Query Integration List - Learn how to query and filter integrations
• Bind to Cloud Function - Learn how to bind integrations to cloud functions