# Install kubekey with Homebrew

Installer for Kubernetes and / or KubeSphere, and related cloud-native add-ons. Version 4.0.5 via Homebrew; verified 2026-06-05.

## Install

```sh
sudo av install brew:kubekey
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install kubekey
```

  Evidence: local Homebrew formula metadata

## Package facts

- **Package key:** brew:kubekey
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/kubekey>
- **Version:** 4.0.5
- **Source summary:** Installer for Kubernetes and / or KubeSphere, and related cloud-native add-ons
- **Homepage:** <https://kubesphere.io>
- **Repository:** <https://github.com/kubesphere/kubekey>
- **Upstream docs:** <https://github.com/kubesphere/kubekey>
- **License:** Apache-2.0
- **Source archive:** <https://github.com/kubesphere/kubekey.git>
- **Last updated:** 2026-06-05T12:50:08Z
- **Generated:** 2026-07-08T07:18:31+00:00

## Executables

- kk (cli)
- kk (alias)

## Build dependencies

- go

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-07-08
- Package-manager version: 4.0.5
- Package-manager updated: 2026-06-05
- Local data: ok
- Upstream repository: https://github.com/kubesphere/kubekey
- info: No cached GitHub release or tag data was available.
## Project history and usage

KubeKey is the KubeSphere ecosystem's installer and task-execution CLI for Kubernetes, KubeSphere, and related cloud-native add-ons. It is packaged as the kk executable and is used for cluster creation, upgrades, scaling, offline artifacts, and later task-flow style automation.

### Project history

The public GitHub repository was created on March 19, 2020. KubeSphere documentation from the KubeKey installation guide refers to KubeKey version 1.0.1, and the repository README describes KubeKey as an open source lightweight task-flow execution tool that provides a flexible way to install Kubernetes.

The README says the 3.x line expanded KubeKey from a Kubernetes lifecycle-management tool into a task-execution tool with template management and multiple connection methods. The 4.x release packaging also includes web-installer assets, schema files, task templates, and offline package tooling.

### Adoption history

KubeKey adoption is tied closely to KubeSphere installation and lifecycle management. It became the path for installing Kubernetes alone or installing Kubernetes and KubeSphere together, especially for users who wanted all-in-one, multi-node, highly available, or offline setups.

The project is less broadly packaged than kubectx or kubelogin, but its Homebrew formula is useful for operators who want the kk binary installed through the same package manager as kubectl and other cluster tools.

### How it is used

A common workflow is to run kk create config to generate config-sample.yaml, edit host and cluster settings, and then run kk create cluster -f config-sample.yaml. The repository documentation also covers node add/delete operations, certificate renewal, offline artifact export, image registry setup, and dependency packages.

KubeKey's configuration file can include host connection details, Kubernetes version, networking, registry mirrors, and add-ons. That makes it closer to an installer plus declarative cluster recipe than a single-purpose kubectl plugin.

### Why package nerds care

KubeKey is notable because it packages a full Kubernetes/KubeSphere installer as a single CLI binary. For package-manager users, kk sits in the same mental bucket as kubeadm wrappers and distribution installers: a bootstrap executable whose version controls a large amount of cluster state.

### Timeline

- 2020-03-19: Public GitHub repository created
- 2021: KubeSphere installation documentation referenced KubeKey version 1.0.1
- 2023: 3.x README described expansion from lifecycle management to task execution
- 2026-06-05: v4.0.5 release published

### Related projects

- KubeSphere is the platform ecosystem for which KubeKey is an installer and lifecycle tool.
- kubeadm is listed among the repository topics and is part of the broader Kubernetes bootstrap context.
- Ansible is referenced by the README as an inspiration for KubeKey's task-flow design.

### Sources

- <https://api.github.com/repos/kubesphere/kubekey>
- <https://formulae.brew.sh/formula/kubekey>
- <https://github.com/kubesphere/kubekey>
- <https://github.com/kubesphere/kubekey/releases>
- <https://github.com/kubesphere/kubekey/tree/main/docs>
- <https://kubesphere.io/blogs/install-kubernetes-using-kubekey/>


## Security Notes

infrastructure mutation or orchestration signal.

- **Geiger risk:** orange / medium
- infrastructure mutation or orchestration signal


## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: config-sample.yaml
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** kubekey
- **Aliases:** kk
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable


## Related links

- [Cloud CLI packages](https://www.automicvault.com/pkg/cloud-clis/) - Belongs to a cloud or infrastructure command family.
- [Secret-risk packages](https://www.automicvault.com/pkg/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [go](https://www.automicvault.com/pkg/brew/go/) - Build dependency declared by Homebrew.
- [cmctl](https://www.automicvault.com/pkg/brew/cmctl/) - Shares av.db curated category or tags: cli, cluster-management, developer-tools, kubernetes.
- [kubernetes-cli](https://www.automicvault.com/pkg/brew/kubernetes-cli/) - Shares av.db curated category or tags: cli, cluster-management, developer-tools, kubernetes.
- [chart-releaser](https://www.automicvault.com/pkg/brew/chart-releaser/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [chart-testing](https://www.automicvault.com/pkg/brew/chart-testing/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [cri-tools](https://www.automicvault.com/pkg/brew/cri-tools/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [kamel](https://www.automicvault.com/pkg/brew/kamel/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [kapp](https://www.automicvault.com/pkg/brew/kapp/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [karmadactl](https://www.automicvault.com/pkg/brew/karmadactl/) - Shares av.db curated category or tags: cli, developer-tools, kubernetes.
- [kagent](https://www.automicvault.com/pkg/brew/kagent/) - Local package facts share a topical domain. Shared terms: cli, cloud, cloud-native, developer, developer-tools.

## Combined YAML source

View the package source record on GitHub. [combined/kubekey.yml](https://github.com/automic-vault/db/blob/main/combined/kubekey.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- cross-ecosystem install command graph
