krew

README

krew

krew is the missing kubectl plugin manager.

What is krew?

krew is a tool that makes it easy to install kubectl plugins. krew helps you discover plugins, install and manage them on your machine. It is similar to tools like apt, dnf or brew.

Installation

For macOS and Linux:

• Make sure that git is installed.
• Paste this command to your terminal:

(
  set -x; cd "$(mktemp -d)" &&
  curl -fsSLO "https://github.com/GoogleContainerTools/krew/releases/download/v0.1.1/krew.zip" &&
  unzip krew.zip &&
  "./out/build/krew-$(uname | tr '[:upper:]' '[:lower:]')" install krew
)

Windows:

1. Make sure that git is installed
2. Download https://github.com/GoogleContainerTools/krew/releases/download/v0.1.1/krew.zip
3. Unzip the file
4. Launch a command-line window in the extracted directory
5. Run: ./out/build/krew-windows.exe install krew

To verify the installation run kubectl plugin. You should see new subcommands. Run kubectl plugin list to see all installed plugins.

Finding plugins

This command shows all the plugins available in krew index:

kubectl plugin search

Installing plugins

Choose one of the plugins from the list returned in the previous command, for example:

kubectl plugin install ca-cert

This plugin ("ca-cert") prints the CA cert of the current cluster as PEM. Execute this plugin by running the command:

kubectl plugin ca-cert

Uninstalling a plugin

kubectl plugin remove ca-cert

Documentation

Read the complete User Guide for more details.

Publishing Plugins

To publish your plugin on krew, you need to make the releases available for download, and contribute a plugin descriptor file to krew-index repository.

Read the Plugin Developer Guide for details.

Additional Links

• Architecture
• Docs
• Contributing

Roadmap

• Support Multiple Index Repositories: Tracked under #23
• Donating krew to the SIG-CLI: We plan to donate krew to the SIG-CLI. We have created a KEP that covers our intentions. Accepting the KEP means that kubectl will implement krew commands natively, and support the plugin format.

LICENSE

The code is submitted under the Apache 2.0 License described in the LICENSE file.

---

This is not an official Google project.