Skip to content

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-memory skill, which teaches your agent how to use that memory.

Human-only browsing can work with just the CLI. Agent workflows should install both.

If you are an AI coding assistant (Claude Code, Codex, etc.) installing sivtr on behalf of a user:

Terminal window
sivtr --version # Already installed?
sivtr doctor # Full environment check

If sivtr --version succeeds, do not reinstall. Run sivtr doctor to verify the environment and skip to the skill installation below.

Terminal window
# 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. Verify
sivtr --version
# 3. Shell hook (pick one)
sivtr init bash # Linux default
sivtr init zsh # macOS default
sivtr init powershell # Windows
sivtr init nushell
# 4. Config
sivtr config init
# 5. Skill (for agent workflows)
npx skills add Ariestar/sivtr --skill sivtr-memory -g
Terminal window
sivtr doctor

Expected 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.

Terminal window
sivtr init show # Which shell hooks are installed
sivtr doctor # Full diagnostics
Terminal window
sivtr init uninstall # Remove all shell hooks
cargo uninstall sivtr # Remove binary
  • Rust and Cargo
  • A supported terminal
  • Clipboard support for your platform

Optional:

  • nvim, vim, or vi for the Vim picker view used by some copy workflows
  • PowerShell, Bash, Zsh, or Nushell shell profile access for session logging

Install the latest published release from crates.io:

Terminal window
cargo install sivtr

Verify the binary:

Terminal window
sivtr --version
sivtr --help

Download a pre-built binary without compiling:

Terminal window
curl -fsSL https://raw.githubusercontent.com/Ariestar/sivtr/main/install.sh | sh

Pin a specific version:

Terminal window
SIVTR_VERSION=v0.1.3 curl -fsSL https://raw.githubusercontent.com/Ariestar/sivtr/main/install.sh | sh

This downloads a static binary to ~/.local/bin/sivtr (or $SIVTR_INSTALL_DIR). Requires no Rust toolchain.

Clone the repository:

Terminal window
git clone https://github.com/Ariestar/sivtr.git
cd sivtr

From the repository root:

Terminal window
cargo install --path .

Install the sivtr-memory skill globally with the Skills CLI:

Terminal window
npx skills add Ariestar/sivtr --skill sivtr-memory -g

After 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 the published package:

Terminal window
cargo install sivtr --force

Or reinstall from a local checkout after pulling changes:

Terminal window
git pull
cargo install --path . --force

Cargo will replace the previously installed binary.

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:

Terminal window
sivtr init powershell
sivtr init bash
sivtr init zsh
sivtr init nushell

Check which hooks are installed:

Terminal window
sivtr init show

Uninstall all hooks:

Terminal window
sivtr init uninstall

Restart 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>.log or ~/.local/state/sivtr/session_<pid>.log.
  • Nushell uses its config directory with a sivtr session file.

Create the default config file:

Terminal window
sivtr config init

Show the path and current content:

Terminal window
sivtr config show

Edit it with your configured editor:

Terminal window
sivtr config edit

See Config File for all supported settings.