Installation
All install methods and shell setup
On this page
Overview
klaudiush ships as a single binary with no runtime dependencies. Pick the install method
that fits your setup. All methods put the klaudiush binary on your PATH.
Homebrew
The recommended method for macOS and Linux. Installs from the official Homebrew tap
with automatic updates via brew upgrade.
brew install smykla-skalski/tap/klaudiush Install script
The install script detects your platform (Linux, macOS, Windows), architecture
(amd64, arm64), downloads the binary from GitHub releases, and verifies SHA256
checksums. Default install directory is ~/.local/bin.
# Default install to ~/.local/bin
curl -sSfL https://klaudiu.sh/install.sh | sh
# Specific version
curl -sSfL https://klaudiu.sh/install.sh | sh -s -- -v v1.18.0
# Custom install directory
curl -sSfL https://klaudiu.sh/install.sh | sh -s -- -b /usr/local/bin PATH check
The script warns if the install directory isn't in your PATH. Add it to your shell profile if needed.
Nix flake
Run directly or install to your Nix profile. The flake supports all platforms via the overlay system.
# Run directly
nix run github:smykla-skalski/klaudiush?dir=nix
# Install to profile
nix profile install github:smykla-skalski/klaudiush?dir=nix For Home Manager integration, import the module and enable the program:
{
inputs.klaudiush.url = "github:smykla-skalski/klaudiush?dir=nix";
# In your home-manager config:
imports = [ inputs.klaudiush.homeManagerModules.default ];
programs.klaudiush.enable = true;
} From source
Requires Go 1.24+ and Task.
Builds with optimizations and installs to ~/.local/bin.
git clone https://github.com/smykla-skalski/klaudiush.git
cd klaudiush
task build:prod
# Binary installed to ~/.local/bin/klaudiush Shell completion
Generate and install tab completions for your shell. Completions cover all commands, subcommands, and flags.
# Bash
klaudiush completion bash | sudo tee /usr/local/etc/bash_completion.d/klaudiush
# Zsh
klaudiush completion zsh | sudo tee /usr/local/share/zsh/site-functions/_klaudiush
# Fish
klaudiush completion fish > ~/.config/fish/completions/klaudiush.fish Updating
klaudiush has a built-in self-update command that downloads the release from GitHub, verifies the SHA256 checksum, and atomically replaces the binary.
klaudiush update # Update to latest
klaudiush update --to v1.18.0 # Update to specific version
klaudiush update --check # Check without installing Homebrew users can also update via brew upgrade klaudiush. The self-update
command resolves symlinks, so it works correctly with Homebrew installs.
Verify installation
Check that the binary is available and run the doctor command to verify your setup.
klaudiush --version
klaudiush doctor