Skip to content
Shirei

Install Shirei

Requirements

Section titled “Requirements”

Install these before Shirei:

  • Rust 1.93 or newer for cargo install.
  • git.
  • fzf for interactive pickers.
  • Either tmux or herdr as the session backend.

The unfinished-worktree report can also use:

  • gh for GitHub pull requests.
  • glab for GitLab merge requests.

  1. Install from crates.io

    Terminal window
    cargo install shirei

    Cargo installs one shirei binary under ~/.cargo/bin.

  2. Verify the installation

    Terminal window
    shirei --version
    shirei --help

  3. Open the picker

    Terminal window
    shirei

Install from source

Section titled “Install from source”
Terminal window
git clone https://github.com/avenceslau/shirei.git
cd shirei
cargo install --path .

Update

Section titled “Update”

Reinstall the latest published crate:

Terminal window
cargo install shirei --force

Check the installed behavior after an update:

Terminal window
shirei --version
shirei --help
shirei worktrees --help

Shell completions

Section titled “Shell completions”

Generate completions for Bash, Elvish, Fish, PowerShell, or Zsh:

Terminal window
shirei completions zsh

See integrations for persistent shell setup and terminal bindings.