Skip to content

Installation

Requirements

  • Python 3.10 or newer (3.12 recommended; tested on 3.10–3.14)
  • Git 2.38+ (worktree support)
  • Linux or macOS (POSIX-only)
  • GitHub CLI (gh) — optional, required only for renv pr (install)
uv tool install repo-env
renv --help

Alternative: pipx

pipx install repo-env
renv --help

Alternative: pip (virtual environment)

python3 -m venv .venv && source .venv/bin/activate
pip install repo-env
renv --help

Verify installation

renv --version

GitHub CLI (for renv pr)

gh auth login
gh auth status

Shell completion

Install into your shell's completion directory (detects the shell from $SHELL, prompts once):

renv --install-completion

Or specify explicitly, and restart your shell (or source its rc file) afterward:

renv --install-completion bash

renv --install-completion zsh

renv --install-completion fish

Upgrading

uv tool upgrade repo-env   # or: pipx upgrade repo-env

Next steps