Install Hokan

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/hokan-installer.sh \  | HOKAN_VERSION=0.1.0 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. Private state lives in ~/.hokan; the installer creates and permission-checks it up front, so the first launch cannot fail on directory access.

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/hokan-installer.sh \  | HOKAN_VERSION=0.1.0 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

Variable	Purpose
HOKAN_VERSION	Install an exact release such as 0.1.0
HOKAN_INSTALL_DIR	Override the binary directory
HOKAN_MAN_DIR	Override the man-page directory
HOKAN_SHELL	Select zsh, bash, or fish
HOKAN_RC_FILE	Select an explicit shell rc file
HOKAN_STATE_DIR	Override the private state directory (default ~/.hokan)
HOKAN_ON_DEMAND=1	Install hk without automatic startup