Submitting plugins to Krew

Krew maintains a centralized plugin index at the krew-index repository. Since this repository is cloned on Krew user’s machine, it helps them find existing plugins.

Pre-submit checklist

  1. Familiarize yourself with Krew plugin naming guide.
  2. Read the plugin development best practices.
  3. Make sure your plugin’s source code is available as open source.
  4. Adopt an open source license, and add it to your plugin archive file.
  5. Make sure to extract the LICENSE file during the plugin installation.
  6. Tag a git release with a semantic version (e.g. v1.0.0).
  7. Test plugin installation locally.

Submitting a plugin to krew-index

Once you followed the checklist above, create a pull request to the krew-index repository with your plugin manifest (e.g. example.yaml) file to the plugins/ directory.

After your pull request is merged, users can now find and install your plugin through Krew.

← Developer Guide