kat

(β˜… 165)

TUI and rule-based rendering engine for Kubernetes manifests

  • .commitlintrc.yaml
  • .editorconfig
  • .envrc
  • .gitignore
  • .golangci.yaml
  • .goreleaser.yaml
  • .lefthook.yaml
  • .prettierignore
  • .prettierrc.yaml
  • CLAUDE.md
  • dagger.json
  • devbox.json
  • devbox.lock
  • gen.sh
  • go.mod
  • go.sum
  • LICENSE
  • README.md
  • Taskfile.yaml

# Installation Guide

1. Get the code
git clone https://github.com/MacroPower/kat

Downloads the entire project code from GitHub to your computer.

cd kat

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Go Go is required to use go install.
brew install macropower/tap/kat --cask

Installs the pre-built package via Homebrew β€” no source build required.

go install github.com/macropower/kat/cmd/kat@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -it -v .:/data -e TERM=$TERM ghcr.io/macropower/kat:latest-alpine

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install github.com/macropower/kat/cmd/kat@latest

Downloads and installs the specified version directly β€” no need to clone the repo yourself.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation