kubernetes-sigs/krew
Krew
Krew is a command-line extension manager and cross-platform plugin installer designed specifically for the kubectl ecosystem. It functions as a package manager that allows users to discover, install, and update community-driven extensions to add new capabilities to the Kubernetes command line interface.
The project utilizes a manifest-based distribution system where YAML files map binaries to specific operating systems and architectures. This ensures secure deployment through the use of checksums for integrity verification and enables the hosting of both public and private plugin registries.
Its operational surface covers the entire plugin lifecycle, including repository searching, version updates, and the removal of extensions. It also provides tools for plugin developers to define distribution manifests, test installations across target platforms, and automate release cycles via Git-backed registries.
Users can manage their environment by exporting and restoring installed plugin sets or by relocating the application storage path using environment variables.
Features
- Kubernetes Management - Acts as the primary package manager for extending the kubectl command line interface with community tools.
- Cross-Platform Binary Distribution - Distributes pre-compiled binaries compatible with multiple operating systems and architectures.
- CLI Extension Managers - Provides a system for discovering, installing, and managing custom CLI extensions via a central index.
- Command Line Interface Plugins - Provides a framework for discovering and installing community-developed plugins to extend the kubectl command line interface.
- Cross-Platform Package Managers - Implements a package management system that provides a unified installation interface across different operating systems.
- Executable Binary Mapping - Maps specific binary files to a standardized command name for seamless shell execution across different operating systems.
- Extensible Command-Line Interfaces - Manages the lifecycle of cross-platform binary plugins through YAML manifests and centralized indexes.
- Integrity Verification - Uses YAML manifests to specify plugin checksums, ensuring the integrity and security of downloaded binaries.
- Plugin Management - Handles the discovery, installation, verification, and updating of kubectl extensions.
- Kubernetes Ecosystem - Provides a specialized tool for distributing and installing extensions within the Kubernetes ecosystem.
- Native Installation Upgrades - Checks for newer versions of installed plugins and upgrades them to provide the latest features and fixes.
- Cross-Platform Installers - Installs plugins by mapping the user's OS and architecture to the correct verified binary.
- Plugin Managers - Provides a way to search and filter available community extensions to find tools that meet user needs.
- Distribution Metadata - Defines the metadata and installation instructions required to distribute custom executables as managed plugins.
- Cross-Platform Binary Mappings - Maps specific binaries to different operating systems and architectures to ensure compatible plugin delivery.
- Plugin Installation Utilities - Automates the download and integrity verification of plugins to ensure safe execution.
- Plugin Registries - Uses a Git repository as a version-controlled registry for plugin discovery and community contributions.
- Plugin Distributions - Implements a manifest-based distribution system using YAML to map plugins to versioned URIs and checksums.
- Package Search Interfaces - Offers an interface for searching through a curated database of available extensions to find specific tools.
- Plugin Set Replication - Saves the list of installed plugins to a file and restores them to recreate the environment on another machine.
- Command Line Extensions - Provides a framework for creating custom command-line extensions to automate repetitive technical tasks.
- Installed Package Management - Includes utilities for querying the list of plugins currently installed on the system.
- Plugin Development Workflows - Facilitates the building and testing of specialized plugins to automate technical tasks.
- Plugin Distribution Tools - Provides mechanisms to update plugin manifests with new versions and checksums to deliver updated binaries.
- Third-Party Registries - Enables users to add, remove, and list third-party plugin repositories for expanded tool discovery.
- Private Plugin Registry Hosting - Maintains private repositories of plugin manifests to control the distribution lifecycle of internal tools.
- Registry Overrides - Allows pointing the package manager to a custom git repository URI instead of the standard index.
- Package Manifests - Uses structured YAML manifests to define plugin versions, metadata, and download URIs for repository indexing.
- Package Distribution - Publishes extension packages to a shared repository for cross-platform discovery and installation.
- Plugin Distribution Packages - Packages and publishes command-line extensions as installable modules to a central index.
- Git Release Automators - Automates plugin version updates in the registry by triggering pull requests on new Git tags.
- Plugin Publishing - Allows plugin authors to submit manifests to a central registry for community discovery and installation.
- File Integrity Verifiers - Verifies the integrity of downloaded plugin binaries using cryptographic digests before execution.
- Curated Index Discovery - Searches through a curated list of compatible tools to find extensions that meet user requirements.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
