Installation
sivtr is published as a Cargo package and developed at github.com/Ariestar/sivtr.
For the full human + agent workflow, install two pieces:
- the CLI/TUI, which captures and retrieves local workspace memory;
- the bundled
sivtr-memoryskill, which teaches your agent how to use that memory.
Human-only browsing can work with just the CLI. Agent workflows should install both.
AI Assistant Quick Install
Section titled “AI Assistant Quick Install”If you are an AI coding assistant (Claude Code, Codex, etc.) installing sivtr on behalf of a user:
Pre-Installation Check
Section titled “Pre-Installation Check”sivtr --version # Already installed?sivtr doctor # Full environment checkIf sivtr --version succeeds, do not reinstall. Run sivtr doctor to verify the environment and skip to the skill installation below.
Install Steps
Section titled “Install Steps”# 1. Install binary (choose one)cargo install sivtr # from source (requires Rust)curl -fsSL https://raw.githubusercontent.com/Ariestar/sivtr/main/install.sh | sh # pre-built
# 2. Verifysivtr --version
# 3. Shell hook (pick one)sivtr init bash # Linux defaultsivtr init zsh # macOS defaultsivtr init powershell # Windowssivtr init nushell
# 4. Configsivtr config init
# 5. Skill (for agent workflows)npx skills add Ariestar/sivtr --skill sivtr-memory -gPost-Install Verification
Section titled “Post-Install Verification”sivtr doctorExpected output: all checks passing. If shell hooks shows “not installed”, run the appropriate sivtr init command. If session log directory shows “missing”, the user needs to restart their terminal after sivtr init.
Check Current Status
Section titled “Check Current Status”sivtr init show # Which shell hooks are installedsivtr doctor # Full diagnosticsUninstall
Section titled “Uninstall”sivtr init uninstall # Remove all shell hookscargo uninstall sivtr # Remove binaryRequirements
Section titled “Requirements”- Rust and 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 with Cargo
Section titled “Install with Cargo”Install the latest published release from crates.io:
cargo install sivtrVerify the binary:
sivtr --versionsivtr --helpQuick Install (Linux/macOS)
Section titled “Quick Install (Linux/macOS)”Download a pre-built binary without compiling:
curl -fsSL https://raw.githubusercontent.com/Ariestar/sivtr/main/install.sh | shPin a specific version:
SIVTR_VERSION=v0.1.3 curl -fsSL https://raw.githubusercontent.com/Ariestar/sivtr/main/install.sh | shThis downloads a static binary to ~/.local/bin/sivtr (or $SIVTR_INSTALL_DIR). Requires no Rust toolchain.
Install from source
Section titled “Install from source”Clone the repository:
git clone https://github.com/Ariestar/sivtr.gitcd sivtrFrom the repository root:
cargo install --path .Install the bundled skill
Section titled “Install the bundled skill”Install the sivtr-memory skill globally with the Skills CLI:
npx skills add Ariestar/sivtr --skill sivtr-memory -gAfter installation, ask your agent to use sivtr first when local context may already exist, for example:
Fix the latest terminal error. Use sivtr first.Update
Section titled “Update”Update the published package:
cargo install sivtr --forceOr reinstall from a local checkout after pulling changes:
git pullcargo install --path . --forceCargo 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 nushellCheck which hooks are installed:
sivtr init showUninstall all hooks:
sivtr init uninstallRestart the terminal after installation or removal.
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.