Skip to content
hokan
On this page

Install Hokan

Install the Hokan beta on macOS or Linux and verify the shell integration.

The release installer detects your operating system, CPU architecture, and current shell. It verifies the release checksum, installs the binary in your home directory, and runs hokan install.

Bash
curl --proto '=https' --tlsv1.2 -LsSf \ https://github.com/backrunner/hokan/releases/download/v0.1.0-beta.10/hokan-installer.sh \ | HOKAN_VERSION=0.1.0-beta.10 sh

Open a new terminal, or restart the current shell:

Bash
exec "$SHELL" -lhokan --versionhokan doctor

The default installation uses ~/.local/bin/hokan and ~/.local/share/man/man1/hokan.1. It does not require sudo.

On-demand mode

Use an hk command instead of starting Hokan for every shell:

Bash
curl --proto '=https' --tlsv1.2 -LsSf \ https://github.com/backrunner/hokan/releases/download/v0.1.0-beta.10/hokan-installer.sh \ | HOKAN_VERSION=0.1.0-beta.10 HOKAN_ON_DEMAND=1 sh

Build from source

Rust 1.96 or newer is required:

Bash
cargo install --git https://github.com/backrunner/hokan --lockedhokan install

For a checkout of this repository:

Bash
cargo install --path . --lockedhokan install

Installer options

VariablePurpose
HOKAN_VERSIONInstall an exact release such as 0.1.0-beta.10
HOKAN_INSTALL_DIROverride the binary directory
HOKAN_MAN_DIROverride the man-page directory
HOKAN_SHELLSelect zsh, bash, or fish
HOKAN_RC_FILESelect an explicit shell rc file
HOKAN_ON_DEMAND=1Install hk without automatic startup