CR(D) Wizard

CR(D) Wizard is a tool designed to provide a clear and intuitive interface for visualizing and exploring Kubernetes Custom Resource Definitions (CRDs) and their corresponding Custom Resources (CRs). It helps developers and cluster administrators quickly understand the state of their custom controllers and the resources they manage.

CR(D) Wizard is available as both a web-based dashboard and a TUI (Text-based User Interface). This allows you to choose the interface that best suits your workflow, whether you prefer a graphical interface or a lightweight, terminal-based view.

---

Web UI

TUI

---

How to install

Krew

kubectl krew install crd-wizard

Homebrew

brew tap pehlicd/crd-wizard https://github.com/pehlicd/crd-wizard
brew install crd-wizard

Arch Linux

${aurHelper:-paru} -S crd-wizard-bin

One Script Installer

You can install the latest version with one command:

sh -c "$(curl -sSflL 'https://raw.githubusercontent.com/pehlicd/crd-wizard/main/install.sh')"

Advanced Usage

Install a specific version: Set the CRD_WIZARD_VERSION environment variable.

CRD_WIZARD_VERSION="0.0.1" sh -c "$(curl -sSflL 'https://raw.githubusercontent.com/pehlicd/crd-wizard/main/install.sh')"

Install to a custom directory: Pass the desired path as an argument.

sh -c "$(curl -sSflL 'https://raw.githubusercontent.com/pehlicd/crd-wizard/main/install.sh')" -- /my/custom/bin

Using Go Install

go install github.com/pehlicd/crd-wizard@latest

How to Use

Using CR(D) Wizard is super simple. Just run the following command:

crd-wizard web

OR if you don't want to leave your terminal run:

crd-wizard tui

k9s plugin

plugins:
  crd-wizard:
    shortCut: Shift-W
    description: CRD Wizard
    dangerous: false
    scopes:
      - crds
    command: bash
    background: false
    confirm: false
    args:
      - -c
      - "crd-wizard tui --kind $COL-KIND"

How to contribute

If you'd like to contribute to CR(D) Wizard, feel free to submit pull requests or open issues on the GitHub repository. Your feedback and contributions are highly appreciated!

Contributors

Thank you for contributing, you're awesome 🫶

License

This project is licensed under the GPL-3.0 - see the LICENSE file for details.