跳到主要内容

安装 kbcli

你可以将 kbcli 安装在笔记本电脑或者云上的虚拟机上。

环境准备​

Windows 用户需配置 PowerShell 5.0 及以上的版本。

安装 kbcli​

kbcli 目前支持 macOS、Windows 和 Linux 系统。

使用 curl 或 brew 安装 kbcli。

  • 选项 1：执行 curl 命令安装 kbcli

    1. 安装 kbcli。

      curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash

      如果想安装 kbcli 的指定版本，请按照以下步骤进行操作：

      1. 在 kbcli 发布页面中查看可用版本。

      2. 使用 -s 指定版本，并执行以下命令。

        curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash -s x.y.z

        您可以通过 kbcli 发布列表 查看 kbcli 的所有版本，包括 alpha 及 beta 版本。

        也可通过执行以下命令，获取稳定版本：

        curl -s "https://api.github.com/repos/apecloud/kbcli/releases?per_page=100&page=1" | jq -r '.[] | select(.prerelease == false) | .tag_name' | sort -V -r
      备注

      kbcli 默认安装最新版本。如果您的环境中已有正在运行的 KubeBlocks 实例，则需要安装与之匹配的 kbcli 版本。

      例如，如果您当前使用的 KubeBlocks 版本是 v0.8.3，kbcli 应安装对应的 v0.8.3，而不是更高版本（如 v0.9.0），否则系统将因版本不匹配产生报错。

    2. 执行 kbcli version 命令，检查 kbcli 版本并确保已成功安装。

      备注

      如果安装超时，请检查你的网络设置并重试。

  • 选项 2：用 Homebrew 安装 kbcli

    1. 安装 ApeCloud 的 Homebrew 包（ApeCloud tap）。

      brew tap apecloud/tap

    2. 安装 kbcli。

      brew install kbcli

      如果想安装 kbcli 的指定版本，执行：

      # 查看可用版本 
      brew search kbcli

      # 安装指定版本
      brew install kbcli@x.y.z

    3. 确认 kbcli 是否已成功安装。

      kbcli -h

升级 kbcli​

升级 kbcli 仅需卸载当前版本，并安装新版本。

(可选) 启用 kbcli 的自动补全功能​

kbcli 支持命令行自动补全。

# 配置 SHELL-TYPE 为 bash、fish、PowerShell、zsh 中的一种
kbcli completion SHELL-TYPE -h

举个例子，如果想要启用 zsh 的 kbcli 自动补全功能：

步骤：

  1. 查阅用户指南。

    kbcli completion zsh -h

  2. 启用终端的补全功能。

    echo "autoload -U compinit; compinit" >> ~/.zshrc

  3. 启用 kbcli 的自动补全功能。

    echo "source <(kbcli completion zsh); compdef _kbcli kbcli" >> ~/.zshrc