Installation

Installation

Requirements

• Rust 1.70 or later (for cargo install)
• direnv - recommended for automatic environment loading
• SOPS - required for encryption features (optional)
• GPG - required for GPG-based encryption (optional)

Install rsenv

macOS (Homebrew)

brew tap sysid/rsenv
brew install rsenv

This automatically installs shell completions.

Via Cargo

cargo install rsenv

From Source

git clone https://github.com/sysid/rsenv
cd rsenv/rsenv
cargo install --path .

Verify Installation

rsenv --version
rsenv info

Install direnv

rsenv works best with direnv for automatic environment loading.

macOS

brew install direnv

Linux (Debian/Ubuntu)

apt install direnv

Hook into Shell

Add to your shell config:

bash (~/.bashrc):

eval "$(direnv hook bash)"

zsh (~/.zshrc):

eval "$(direnv hook zsh)"

fish (~/.config/fish/config.fish):

direnv hook fish | source

Install SOPS (Optional)

SOPS is required for vault encryption features.

macOS

brew install sops

Linux

# Download from releases
curl -LO https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.linux.amd64
chmod +x sops-v3.8.1.linux.amd64
sudo mv sops-v3.8.1.linux.amd64 /usr/local/bin/sops

Verify

sops --version

Shell Completions

Generate completions for your shell:

# bash
rsenv completion bash > ~/.local/share/bash-completion/completions/rsenv

# zsh
rsenv completion zsh > ~/.zfunc/_rsenv
# Then add to ~/.zshrc: fpath=(~/.zfunc $fpath)

# fish
rsenv completion fish > ~/.config/fish/completions/rsenv.fish

# powershell
rsenv completion powershell > $HOME\Documents\PowerShell\Modules\rsenv\rsenv.psm1

Initial Configuration

Create a global configuration file:

rsenv config init --global

This creates ~/.config/rsenv/rsenv.toml. Edit to set:

• base_dir - rsenv base directory (vaults stored in base_dir/vaults)
• sops.gpg_key - GPG key for encryption
• editor - preferred editor

See Configuration for details.

Verify Setup

# Check configuration
rsenv config show

# Check paths
rsenv config path

Next Steps

• Quick Start - Initialize your first vault
• Core Concepts - Understand how rsenv works
• Configuration - Customize settings