Installation

Feel free to install Kānuka using any of the following methods, although installing using Go itself is recommended.

Prerequisites

You’ll need to have Go installed first, and have the Go binaries available on your system path. Check the Go installation documentation if you haven’t installed Go already.

It’s also worth making sure that you have your Go binaries on your system path. The Go installation tool should handle that for you, but if you installed Go through a different way (for example, using a package manager like brew), then you’ll need to manually put Go in your path.

Adding Go to your PATH

Linux

~/.bashrc

# add the following line to your `~/.bashrc`
export PATH=$HOME/go/bin:$PATH

macOS

~/.zshrc

# add the following line to your `~/.zshrc`
export PATH=$HOME/go/bin:$PATH

Windows

1. Press win + s and type Environment Variables
2. Click on Environment Variables
3. Under “user variables”, click edit.
4. Add the following:

user variables

%USERPROFILE%\go\bin

Installing Kānuka using Go

On any operating system, just run the following:

go install github.com/PolarWolf314/kanuka@latest

Installing Kānuka using GitHub Releases

Kānuka releases artifacts which can be downloaded directly from GitHub Releases.

Each release page includes the binaries for all supported platforms.

Upgrading Kānuka

If you installed Kānuka using Go, then running the following should be enough:

go install github.com/PolarWolf314/kanuka@latest

If you installed Kānuka using a GitHub Release, just navigate to the GitHub Releases page, and install your existing binary with the newest version.

Shell Autocomplete

Because Kānuka is built using Cobra, shell autocomplete is supported for bash, zsh, fish, and powershell.

Tip

You can run echo $SHELL to help determine your shell.

bash

# Linux:
kanuka completion bash > /etc/bash_completion.d/kanuka

# macOS:
kanuka completion bash > $(brew --prefix)/etc/bash_completion.d/kanuka

zsh

# Linux:
kanuka completion zsh > "${fpath[1]}/_kanuka"

# macOS:
kanuka completion zsh > $(brew --prefix)/share/zsh/site-functions/_kanuka

fish

kanuka completion fish > ~/.config/fish/completions/kanuka.fish

powershell

Add the following to your powershell profile.

kanuka completion powershell | Out-String | Invoke-Expression

Uninstalling

You need to manually remove the Kānuka binary from your system. If you used go install to install Kānuka, then you can just go to the folder where your binaries are installed, and remove the binary.

Tip

You can run echo $GOBIN to find out where your binaries are installed.

If you installed using a GitHub Release, then remove the binary from where you installed it.

Note

You may also want to remove all your related Kānuka files. These will be stored in XDG_DATA_HOME and in XDG_CONFIG_HOME (or your operating system equivalent).