{"id":20001233,"url":"https://github.com/apecloud/kbcli","last_synced_at":"2026-02-11T10:06:29.055Z","repository":{"id":65311932,"uuid":"587544203","full_name":"apecloud/kbcli","owner":"apecloud","description":"The CLI for KubeBlocks.","archived":false,"fork":false,"pushed_at":"2026-01-27T07:35:48.000Z","size":45366,"stargazers_count":24,"open_issues_count":14,"forks_count":15,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-01-30T17:44:40.374Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apecloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-11T01:55:42.000Z","updated_at":"2026-01-27T07:35:53.000Z","dependencies_parsed_at":"2023-09-27T12:05:44.780Z","dependency_job_id":"5e6bb8f3-fa1b-47a5-8eec-e6ce61e92cb1","html_url":"https://github.com/apecloud/kbcli","commit_stats":null,"previous_names":[],"tags_count":483,"template":false,"template_full_name":null,"purl":"pkg:github/apecloud/kbcli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkbcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkbcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkbcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkbcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apecloud","download_url":"https://codeload.github.com/apecloud/kbcli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apecloud%2Fkbcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29331661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T05:17:04.869Z","updated_at":"2026-02-11T10:06:29.050Z","avatar_url":"https://github.com/apecloud.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kbcli\n\nkbcli is a command line interface (CLI) tool for [KubeBlocks](https://github.com/apecloud/kubeblocks).\n\nkbcli has the following features:\n- Manage KubeBlocks, including installation, uninstallation, viewing status, and upgrading, etc.\n- Manage clusters, including creating, deleting, configuration changes, backups and restores, etc.\n- Support playgrounds to quickly experience KubeBlocks locally or on the cloud.\n\n## Install kbcli\n\n### Install kbcli on Linux\n\n#### Install with curl\n\nInstall the latest linux kbcli to `/usr/local/bin`\n\n```bash\ncurl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash\n```\n\n#### Install using native package management\n\n**Debian-based distributions**\n\n1. Update the apt package index and install packages needed to use the kbcli apt repository:\n    ```bash\n    sudo apt-get update\n    sudo apt-get install curl\n    ```\n2. Download the kbcli public signing key:\n    ```bash\n    curl -fsSL https://apecloud.github.io/kbcli-apt/public.key | sudo apt-key add -\n    ```\n3. Add the kbcli apt repository:\n    ```bash\n    echo \"deb [arch=amd64,arm64] https://apecloud.github.io/kbcli-apt/repo stable main\" | sudo tee /etc/apt/sources.list.d/kbcli.list\n    ```\n4. update apt package index with the new repository and install kbcli:\n    ```bash\n    sudo apt-get update\n    sudo apt-get install kbcli\n    ```\n\n***For Debian-based distributions, in addition to the installation method above, you can also install it through the following methods:***\n```bash\necho \"deb [trusted=yes] https://apt.fury.io/kubeblocks/ /\" | sudo tee /etc/apt/sources.list.d/kbcli.list\nsudo apt update\nsudo apt install kbcli\n```\n\n**Red Hat-based distributions**\n\n1. Installs the package yum-utils using the package manager yum.\n    ```bash\n    sudo yum install -y yum-utils\n    ```\n2. Add a new repository to the YUM configuration using yum-config-manager\n    ```bash\n    sudo yum-config-manager --add-repo https://yum.fury.io/kubeblocks/\n    ```\n3. Update the local cache of available packages and metadata from all configured YUM repositories.\n    ```bash\n    sudo yum makecache\n    ```\n4. Install the kbcli.\n    ```bash\n    sudo yum install kbcli --nogpgcheck\n    ```\n5. Install the specified version of kbcli.\n    ```bash\n    sudo yum install kbcli-0.6.0~beta24 --nogpgcheck\n    ```\n### Install kbcli on macOS\n\n#### Install with curl\n\nInstall the latest darwin kbcli to `/usr/local/bin`.\n\n```bash\ncurl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash\n```\n\n#### Install with Homebrew\n\n```bash\nbrew tap apecloud/tap\nbrew install kbcli\n```\n\n### Install kbcli on Windows\n\n#### Install with powershell\n\n1. Run PowerShell as an administrator and execute `Set-ExecutionPolicy Unrestricted`.\n2. Run following script to automatically install kbcli at `C:\\Program Files\\kbcli-windows-amd64`.\n\n```powershell\npowershell -Command \" \u0026 ([scriptblock]::Create((iwr https://www.kubeblocks.io/installer/install_cli.ps1)))\"\n```\n\n#### Install with winGet\n\nMake sure your `powershell/CMD` support `winget` and run:\n\n```bash\nwinget install kbcli\n```\n\n#### Install with scoop\n\n```bash\nscoop bucket add scoop-bucket https://github.com/apecloud/scoop-bucket.git\nscoop install kbcli\n```\n\n#### Install with chocolatey\n\n```bash\nchoco install kbcli\n```\n\n### Install using the Binary Releases\n\nEach release of kbcli includes various OSes and architectures. These binary versions can be manually downloaded and installed.\n\n1. Download your desired [kbcli version](https://github.com/apecloud/kbcli/releases)\n2. Unpack it (e.g. kbcli-linux-amd64-v0.5.2.tar.gz, kbcli-darwin-amd64-v0.5.2.tar.gz)\n3. Move it to your desired location.\n   * For Linux/macOS - `/usr/local/bin` or any other directory in your $PATH\n   * For Windows, create a directory and add it to you System PATH. We recommend creating a `C:\\Program Files\\kbcli` directory and adding it to the PATH.\n\n## Install KubeBlocks on your local machine\n\nThis guide walks you through the quickest way to get started with KubeBlocks, demonstrating how to create a demo environment (Playground) with one kbcli command.\n\n### Prerequisites\n\nMeet the following requirements for a smooth user experience:\n\n* Minimum system requirements:\n    * CPU: 4 cores, use `sysctl hw.physicalcpu` command to check CPU;\n    * RAM: 4 GB, use `top -d` command to check memory.\n\n* Make sure the following tools are installed on your laptop:\n    * [Docker](https://docs.docker.com/get-docker/): v20.10.5 (runc ≥ v1.0.0-rc93) or above;\n    * [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl): it is used to interact with Kubernetes clusters;\n\n### Initialize Playground\n\n ```bash\n kbcli playground init\n ```\n\n This command:\n 1. Creates a Kubernetes cluster in the container with [K3d](https://k3d.io/v5.4.6/).\n 2. Deploys KubeBlocks in the K3d cluster.\n 3. Creates a standalone MySQL cluster.\n\n \u003e NOTE: If you previously ran `kbcli playground init` and it failed, running it again may cause errors. Please run the `kbcli playground destroy` command first to clean up the environment, then run `kbcli playground init` again.\n\nCheck the MySQL cluster repeatedly until the status becomes `Running`.\n\n```bash\nkbcli cluster list\n```\n\n### Try KubeBlocks with Playground\n\nView the database cluster list.\n\n ```bash\n kbcli cluster list\n ```\n\nView the details of a specified database cluster, such as `STATUS`, `Endpoints`, `Topology`, `Images`.\n\n ```bash\n kbcli cluster describe mycluster\n ```\n\n### Destroy Playground\n\n ```bash\n kbcli playground destroy\n ```\n\n## Reference Documentation\n\nSee the [Reference Documentation](https://kubeblocks.io/docs/preview/user_docs/cli) for more information about kbcli commands.\n\n## Contributing to kbcli\n\nSee the [Contributing Guide](https://github.com/apecloud/kbcli/blob/main/CONTRIBUTING.md) to get started with building and developing.\n\n## Code of Conduct\n\nPlease refer to our [KubeBlocks Code of Conduct](https://github.com/apecloud/kubeblocks/blob/main/CODE_OF_CONDUCT.md)\n\n## License\n\nkbcli is under the GNU Affero General Public License v3.0.\nSee the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapecloud%2Fkbcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapecloud%2Fkbcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapecloud%2Fkbcli/lists"}