krew

README

Krew

Krew is the package manager for kubectl plugins.

What does Krew do?

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. Today, over 200 kubectl plugins are available on Krew.

• 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.

Documentation

Visit the Krew documentation to find Installation instructions, User Guide and Developer Guide.

You can follow the Quickstart to get started with Krew.

Contributor Documentation

• Releasing Krew: how to release new version of Krew.
• Plugin Lifecycle: how Krew installs/upgrades plugins and itself. (Not necessarily up-to-date, but it can give a good idea about how Krew works under the covers.)
• Krew Architecture: architectural decisions behind designing initial versions of Krew. (Not up-to-date.)
• Krew Logo: our logo and branding assets.

Visit ./docs for all documentation.

Roadmap

Please check out the Issue Tracker to see the plan of record for new features and changes.

Community

Bug reports

• If you have a problem with the Krew itself, please file an issue in this repository.
• If you're having a problem with a particular plugin's installation or upgrades, file an issue at krew-index repository.
• If you're having an issue with an installed plugin, file an issue for the repository the plugin's source code is hosted at.

Communication channels

• Slack: #krew or #sig-cli
• Mailing List
• Kubernetes Community site

Contributing

Interested in contributing to Krew? Please refer to our Contributing Guidelines for more details.

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.