Installation

koshi ships prebuilt binaries for Linux, macOS, and Windows on x86-64 and ARM64. Pick one method below.

macOS

With Homebrew:

brew install gohyuhan/koshi/koshi

Homebrew adds the koshi tap during installation. Upgrade koshi along with your other outdated packages:

brew update
brew upgrade

Or upgrade only koshi:

brew upgrade koshi

With the release script:

curl --proto "=https" --tlsv1.2 -sSfL \
  https://github.com/gohyuhan/koshi/releases/latest/download/install.sh | bash

Linux

curl --proto "=https" --tlsv1.2 -sSfL \
  https://github.com/gohyuhan/koshi/releases/latest/download/install.sh | bash

Windows

With PowerShell:

powershell -c "irm https://github.com/gohyuhan/koshi/releases/latest/download/install.ps1 | iex"

With Scoop:

scoop bucket add koshi https://github.com/gohyuhan/scoop-koshi
scoop install koshi/koshi

Upgrade after refreshing Scoop:

scoop update
scoop update koshi

From source

Building needs Rust 1.96.

git clone https://github.com/gohyuhan/koshi.git
cd koshi
cargo build --release
./target/release/koshi

Updating in place

koshi checks for a newer release at startup and can install it itself:

koshi update

Since 0.3.0 the running sessions move with it: each session replaces its own program while keeping its panes, the programs in them, and their scrollback, and an attached terminal rejoins on its own. A session that refuses the restart is named on standard error and keeps the old build until you end it and start it again.

koshi server-version    # which build each running server runs

See Update and versions.

Check the installation

koshi doctor

One row per check — config, shell, terminal, directories, router, session directory, and remote access — each rated ok, warn, or fail. See Doctor.