github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/kbcli.md (about)

     1  ---
     2  title: kbcli
     3  ---
     4  
     5  KubeBlocks CLI.
     6  
     7  ### Synopsis
     8  
     9  ```
    10  
    11  =============================================
    12   __    __ _______   ______  __       ______ 
    13  |  \  /  \       \ /      \|  \     |      \
    14  | ▓▓ /  ▓▓ ▓▓▓▓▓▓▓\  ▓▓▓▓▓▓\ ▓▓      \▓▓▓▓▓▓
    15  | ▓▓/  ▓▓| ▓▓__/ ▓▓ ▓▓   \▓▓ ▓▓       | ▓▓  
    16  | ▓▓  ▓▓ | ▓▓    ▓▓ ▓▓     | ▓▓       | ▓▓  
    17  | ▓▓▓▓▓\ | ▓▓▓▓▓▓▓\ ▓▓   __| ▓▓       | ▓▓  
    18  | ▓▓ \▓▓\| ▓▓__/ ▓▓ ▓▓__/  \ ▓▓_____ _| ▓▓_ 
    19  | ▓▓  \▓▓\ ▓▓    ▓▓\▓▓    ▓▓ ▓▓     \   ▓▓ \
    20   \▓▓   \▓▓\▓▓▓▓▓▓▓  \▓▓▓▓▓▓ \▓▓▓▓▓▓▓▓\▓▓▓▓▓▓
    21  
    22  =============================================
    23  A Command Line Interface for KubeBlocks
    24  ```
    25  
    26  ```
    27  kbcli [flags]
    28  ```
    29  
    30  ### Options
    31  
    32  ```
    33        --as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
    34        --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
    35        --as-uid string                  UID to impersonate for the operation.
    36        --cache-dir string               Default cache directory (default "$HOME/.kube/cache")
    37        --certificate-authority string   Path to a cert file for the certificate authority
    38        --client-certificate string      Path to a client certificate file for TLS
    39        --client-key string              Path to a client key file for TLS
    40        --cluster string                 The name of the kubeconfig cluster to use
    41        --context string                 The name of the kubeconfig context to use
    42        --disable-compression            If true, opt-out of response compression for all requests to the server
    43    -h, --help                           help for kbcli
    44        --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
    45        --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
    46        --match-server-version           Require server version to match client version
    47    -n, --namespace string               If present, the namespace scope for this CLI request
    48        --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")
    49    -s, --server string                  The address and port of the Kubernetes API server
    50        --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
    51        --token string                   Bearer token for authentication to the API server
    52        --user string                    The name of the kubeconfig user to use
    53  ```
    54  
    55  ### SEE ALSO
    56  
    57  * [kbcli addon](kbcli_addon.md)	 - Addon command.
    58  * [kbcli alert](kbcli_alert.md)	 - Manage alert receiver, include add, list and delete receiver.
    59  * [kbcli backuprepo](kbcli_backuprepo.md)	 - BackupRepo command.
    60  * [kbcli bench](kbcli_bench.md)	 - Run a benchmark.
    61  * [kbcli builder](kbcli_builder.md)	 - builder command.
    62  * [kbcli class](kbcli_class.md)	 - Manage classes
    63  * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
    64  * [kbcli clusterdefinition](kbcli_clusterdefinition.md)	 - ClusterDefinition command.
    65  * [kbcli clusterversion](kbcli_clusterversion.md)	 - ClusterVersion command.
    66  * [kbcli dashboard](kbcli_dashboard.md)	 - List and open the KubeBlocks dashboards.
    67  * [kbcli dataprotection](kbcli_dataprotection.md)	 - Data protection command.
    68  * [kbcli fault](kbcli_fault.md)	 - Inject faults to pod.
    69  * [kbcli infra](kbcli_infra.md)	 - infra command
    70  * [kbcli kubeblocks](kbcli_kubeblocks.md)	 - KubeBlocks operation commands.
    71  * [kbcli login](kbcli_login.md)	 - Authenticate with the KubeBlocks Cloud
    72  * [kbcli logout](kbcli_logout.md)	 - Log out of the KubeBlocks Cloud
    73  * [kbcli migration](kbcli_migration.md)	 - Data migration between two data sources.
    74  * [kbcli options](kbcli_options.md)	 - Print the list of flags inherited by all commands.
    75  * [kbcli playground](kbcli_playground.md)	 - Bootstrap or destroy a playground KubeBlocks in local host or cloud.
    76  * [kbcli plugin](kbcli_plugin.md)	 - Provides utilities for interacting with plugins.
    77  * [kbcli report](kbcli_report.md)	 - report kubeblocks or cluster info.
    78  * [kbcli version](kbcli_version.md)	 - Print the version information, include kubernetes, KubeBlocks and kbcli version.
    79  
    80  #### Go Back to [CLI Overview](cli.md) Homepage.
    81