Installation
sivtr is a Rust workspace with a CLI/TUI binary and a core library crate. The current installation path is from source.
Requirements
Section titled “Requirements”- Rust toolchain compatible with the repository
rust-toolchain.toml - Cargo
- A supported terminal
- Clipboard support for your platform
Optional:
nvim,vim, orvifor the Vim picker view used by some copy workflows- PowerShell, Bash, Zsh, or Nushell shell profile access for session logging
Install from the repository
Section titled “Install from the repository”From the repository root:
cargo install --path .Verify the binary:
sivtr --versionsivtr --helpUpdate after pulling changes
Section titled “Update after pulling changes”Reinstall from the repository root:
cargo install --path .Cargo will replace the previously installed binary.
Shell integration
Section titled “Shell integration”Shell integration records recent command blocks so sivtr copy, sivtr import, and command-block navigation have structured data to work with.
Install the hook for your shell:
sivtr init powershellsivtr init bashsivtr init zshsivtr init nushellRestart the terminal after installation.
The hook writes a per-process session log:
- Windows PowerShell and PowerShell 7 use
%APPDATA%\sivtr\session_<pid>.log. - Bash and Zsh use
$XDG_STATE_HOME/sivtr/session_<pid>.logor~/.local/state/sivtr/session_<pid>.log. - Nushell uses its config directory with a
sivtrsession file.
Configuration file
Section titled “Configuration file”Create the default config file:
sivtr config initShow the path and current content:
sivtr config showEdit it with your configured editor:
sivtr config editSee Config File for all supported settings.