Installation

KubeTidy can be installed through either the PowerShell Gallery or via Krew for Linux and macOS users.

You can install KubeTidy directly from the PowerShell Gallery:

Install-Module -Name KubeTidy -Repository PSGallery -Scope CurrentUser

To update KubeTidy:

Update-Module -Name KubeTidy

Installing via Krew (Linux and macOS)

To install KubeTidy as a kubectl plugin using Krew:

  1. Install Krew: Follow the instructions here.
  2. Install KubeTidy:
# Fetch the latest release tag using GitHub's API
LATEST_VERSION=$(curl -s https://api.github.com/repos/KubeDeckio/KubeTidy/releases/latest | grep '"tag_name"' | sed -E 's/.*"([^"]+)".*/\1/')

# Download the KubeTidy.yaml file from the latest release
curl -L -H "Cache-Control: no-cache" -O https://github.com/KubeDeckio/KubeTidy/releases/download/$LATEST_VERSION/KubeTidy.yaml

# Install the plugin using the downloaded KubeTidy.yaml file
kubectl krew install --manifest="./KubeTidy.yaml"

Requirements

  • PowerShell Version: PowerShell 7 or higher is required.
  • Additional Dependencies: The powershell-yaml module is needed for YAML parsing. It will be automatically installed when running KubeTidy from PowerShell.

Now that you’ve installed KubeTidy, head over to the Usage Guide to start cleaning up your Kubernetes configurations!