Project: KubeBlocks by ApeCloud (App Definition and Development / Database)
File: kbcli.md

title: kbcli KubeBlocks CLI. ``` ============================================= _ | \ / \ \ / \| \ | \ | / \ \ \ | / | / \ | | | | | | \ | \ | | | \\| / / \ | _ | \\ \ \ \ \ \\ \ \\ ============================================= A Command Line Interface for KubeBlocks ``` ``` kbcli [flags] ``` ``` --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. --as-uid string UID to impersonate for the operation. --cache-dir string Default cache directory (default "$HOME/.kube/cache") --certificate-authority string Path to a cert file for the certificate authority --client-certificate string Path to a client certificate file for TLS --client-key string Path to a client key file for TLS --cluster string The name of the kubeconfig cluster to use --context string The name of the kubeconfig context to use --disable-compression If true, opt-out of response compression for all requests to the server -h, --help help for kbcli --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kubeconfig string Path to the kubeconfig file to use for CLI requests. --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use ``` - Addon command. - Manage alert receiver, include add, list and delete receiver. - BackupRepo command. - Run a benchmark. - builder command. - Manage classes - Cluster command. - ClusterDefinition command. - ClusterVersion command. - 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. - List and open the KubeBlocks dashboards. - Data protection command. - Inject faults to pod. - infra command - KubeBlocks operation commands. - Authenticate with the KubeBlocks Cloud - Log out of the KubeBlocks Cloud - Data migration between two data sources. - Print the list of flags inherited by all commands. - kbcli org is used to manage cloud organizations and is only suitable for interacting with cloud. - Bootstrap or destroy a playground KubeBlocks in local host or cloud. - Provides utilities for interacting with plugins. - report kubeblocks or cluster info. - Print the version information, include kubernetes, KubeBlocks and kbcli version.