Skip to content

Command reference

CommandInteractiveDescription
shireiYesOpen the main picker; same as shirei pick
shirei pickYesOpen the main picker explicitly
shirei branch [name]SometimesOpen an existing branch worktree or create one after choosing a base
shirei branch <name> --base <ref>Session switch onlyCreate a named branch from a known base or open it if it exists
shirei recentNoPrint saved recent directories
shirei sessionsNoPrint live sessions from the configured backend
shirei killYesSelect live sessions or workspaces to close
shirei completions <shell>NoGenerate Bash, Elvish, Fish, PowerShell, or Zsh completions
shirei worktreesNoPrint tracked worktree registry entries
shirei worktrees unfinishedNoReport potential unfinished work without active or merged reviews
shirei worktrees scanNoRebuild the registry from discovered Git worktrees
shirei worktrees pruneYesSelect and permanently delete worktrees and local branches
Terminal window
shirei --version
shirei --help
shirei branch --help
shirei worktrees --help

Shirei currently has no JSON output, noninteractive picker mode, or command that changes the parent shell’s directory.

Treat these as interactive:

  • shirei and shirei pick.
  • shirei branch when name or base requires a picker.
  • shirei kill.
  • shirei worktrees prune.

Read-only commands such as recent, sessions, worktrees, and worktrees unfinished are suitable for reports, but their output is human-oriented and can evolve.

Canceling an fzf picker normally exits successfully without acting. A zero status therefore does not prove a selection or mutation occurred.