Skip to content

Quick Start

renv quickstart demo

1. First-run setup

renv init

The wizard asks for your source directory (where git clones live) and destination root for environments. Settings are stored in ~/.config/repoenv/repoenv.yaml on Linux (see Configuration).

2. Populate your source tree (optional)

Already have clones under ~/src? Skip this. Starting from scratch:

renv clone -u https://github.com/my-org -s ~/src

Clones land as ~/src/github.com/my-org/<repo>/ — see renv clone.

3. Create an environment

renv create web -s ~/src -b feature/my-task --activate

renv scans ~/src for git repositories, creates a worktree on branch feature/my-task in each match, and registers the environment web. --activate sets it as the default for future commands.

4. List environments

renv ls

5. Navigate to an environment

cd "$(renv path web)"

Inside an environment directory you can omit the env name on most commands.

6. Run a command across all worktrees

renv run web -- git status
renv run -- make test          # same, when active or cwd is inside web

7. Open bulk pull requests

Requires GitHub CLI (gh auth login).

renv pr web --title "feat: migrate X to Y" --draft
renv pr web --title "feat: migrate X to Y" --push   # push branches first

renv pr never pushes unless --push is given.

8. Tear down an environment

renv rm web --delete-files    # remove registry + worktrees + env dir
renv rm web                   # registry-only (files stay on disk)

Source clones under ~/src are never deleted.

Next steps