krew

README

krew

krew is the package manager for kubectl plugins.

What is krew?

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

• For kubectl users: krew helps you find, install and manage kubectl plugins in a consistent way.
• For plugin developers: krew helps you package and distribute your plugins on multiple platforms and makes them discoverable.

krew is easy to use:

kubectl krew search               # show all plugins
kubectl krew install view-secret  # install a plugin named "view-secret"
kubectl view-secret               # use the plugin
kubectl upgrade                   # upgrade installed plugins
kubectl remove view-secret        # uninstall a plugin

Read the User Guide for detailed documentation.

Installation

⚠ Warning: krew is only compatible with kubectl v1.12 or higher.

macOS and Linux:

1. Make sure that git is installed.

2. Run this command in your terminal to download and install krew:

   (
     set -x; cd "$(mktemp -d)" &&
     curl -fsSLO "https://storage.googleapis.com/krew/v0.2.1/krew.{tar.gz,yaml}" &&
     tar zxvf krew.tar.gz &&
     ./krew-"$(uname | tr '[:upper:]' '[:lower:]')_amd64" install \
       --manifest=krew.yaml --archive=krew.tar.gz
   )
   

3. Add $HOME/.krew/bin directory to your PATH environment variable. To do this, update your .bashrc or .zshrc file and append the following line:

   export PATH="${KREW_ROOT:-$HOME/.krew}/bin:$PATH"
   

   and restart your shell.

Windows:

1. Make sure git is installed on your system.

2. Download krew.zip and krew.yaml from the Releases page.

3. Extract the krew.zip archive to a directory, navigate to the directory.

4. Launch a command-line window (cmd.exe) in that directory.

5. Run the following command to install krew (pass the correct paths to krew.yaml and krew.zip below):

   .\krew-windows_amd64.exe install --source=krew.yaml --archive=krew.zip
   

6. Add %USERPROFILE%\.krew\bin to your PATH environment variable (how?)

Verifying installation

Run kubectl plugin list command to see installed plugins. This command should show kubectl-krew in the results. You can now use kubectl krew command.

Upgrading krew

Since krew itself is installed as a "kubectl plugin" managed by krew, it can be upgraded by running the krew upgrade command.

Documentation

• Users:
  • Read the User Guide to learn how to use krew.
• Plugin Developers:
  • Developer Guide: how to package and publish a plugin for krew.
  • Naming Guide: how to choose a good name for your plugin
• Krew Developers:
  • Building Krew (not written yet)
  • Releasing Krew: how to release new version of krew.
  • Plugin Lifecycle: how krew installs/upgrades plugins and itself.
  • Krew Architecture: architectural decisions behind designing krew.

Visit ./docs for all documentation.

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.