Skip to main content
Version: Preview

KubeBlocks CLI Overview

addon

Addon command.

alert

Manage alert receiver, include add, list and delete receiver.

backuprepo

BackupRepo command.

bench

Run a benchmark.

builder

builder command.

  • kbcli builder migrate-scripts - migrate - a developer tool.
  • kbcli builder template - tpl - a developer tool integrated with KubeBlocks that can help developers quickly generate rendered configurations or scripts based on Helm templates, and discover errors in the template before creating the database cluster.

class

Manage classes

cluster

Cluster command.

clusterdefinition

ClusterDefinition command.

clusterversion

ClusterVersion command.

context

kbcli context allows you to manage cloud context. This command is currently only applicable to cloud, and currently does not support switching the context of the local k8s cluster.

dashboard

List and open the KubeBlocks dashboards.

dataprotection

Data protection command.

fault

Inject faults to pod.

infra

infra command

kubeblocks

KubeBlocks operation commands.

login

Authenticate with the KubeBlocks Cloud

logout

Log out of the KubeBlocks Cloud

migration

Data migration between two data sources.

options

Print the list of flags inherited by all commands.

org

kbcli org is used to manage cloud organizations and is only suitable for interacting with cloud.

playground

Bootstrap or destroy a playground KubeBlocks in local host or cloud.

plugin

Provides utilities for interacting with plugins.

Plugins provide extended functionality that is not part of the major command-line distribution.

report

report kubeblocks or cluster info.

version

Print the version information, include kubernetes, KubeBlocks and kbcli version.