Cheatdirenv Per-directory environments
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
eval "$(direnv hook bash)"
Hook into your shell
echo 'export FOO=1' > .envrc
Write an .envrc
direnv allowTrust it, load it
direnv statusWhat is loaded?
direnv edit .Edit and auto-allow
direnv reloadForce a reload
direnv denyRevoke trust
direnv exec <dir> <cmd>
Run with that env
Concepts
- cd into dir shell prompt
- Find .envrc checks allow list
- Run in bash stdlib available
- Shell env restored on leaving
Setup
eval "$(direnv hook bash)"
Hook for bash (end of ~/.bashrc)
eval "$(direnv hook zsh)"
Hook for zsh (end of ~/.zshrc)
direnv hook fish | source
Hook for fish (config.fish)
direnv versionPrint the installed version
direnv version <x.y.z>
Fail if older than this version
~/.config/direnv/direnv.toml
Global config file
direnv helpShow the help text
Trust
direnv allow [<path>]
Trust and load an .envrc
Needed again after every change to the file.
direnv deny [<path>]
Revoke trust for an .envrc
direnv edit [<path>]
Open in $EDITOR, allow on save
direnv pruneDrop stale entries from the allow list
direnv allow .env
Trust a .env file
Only loaded when load_dotenv is enabled.
[whitelist] prefix = ["<dir>"]
Auto-trust a directory tree
In direnv.toml. Dangerous: anyone able to write there can run
code as you.
Inspect and run
direnv statusShow loaded file and allow state
direnv reloadTrigger a reload
direnv exec <dir> <cmd>
Run a command under that dir's env
direnv export json
Print the env diff as JSON
direnv export bash
Print the exports for a shell
direnv stdlibPrint the stdlib source
direnv fetchurl <url> [<hash>]
Download into the content store
Environment (.envrc)
export <NAME>=<value>
Set a variable
PATH_add <dir>
Prepend a directory to PATH
path_add <VAR> <dir>
Prepend to any path variable
PATH_rm '<pattern>'
Remove matching PATH entries
env_vars_required <VAR> ...
Complain when variables are unset
has <command>
True if a command exists
load_prefix <dir>
Set PATH, MANPATH, PKG_CONFIG_PATH for a prefix
on_git_branch [<branch>]
True on that git branch
strict_envExit on errors and unset variables
Loading files
dotenv [<file>]
Load a .env file
dotenv_if_exists [<file>]
Load .env only if present
source_upInherit the nearest parent .envrc
Returns 1 if there is none; use source_up_if_exists to stay
silent.
source_env <path>
Load another .envrc
Not covered by the allow check.
source_env_if_exists <file>
Load another file if present
watch_file <file> ...
Reload when these files change
watch_dir <dir>
Reload when a directory changes
Layouts and tools
layout python3Project virtualenv in .direnv/
layout python <exe>
Virtualenv from a given Python
layout pyenv <version>
Virtualenv from pyenv
layout uvSync and activate the uv project env
layout nodeAdd node_modules/.bin to PATH
layout goProject GOPATH and bin on PATH
layout pixiLoad the pixi environment
use node [<version>]
Pick Node from .nvmrc or a version
use flake [<installable>]
Load a Nix flake devShell
use nix [-p <pkg>]
Load nix-shell environment
use rbenvPut rbenv Ruby wrappers on PATH
use julia <version>
Load a Julia version
Config (direnv.toml)
load_dotenv = true
Also load .env files
strict_env = true
Strict shell options for every .envrc
hide_env_diff = true
Hide the export diff on load
warn_timeout = "<time>"
Slow-command warning delay (default 5s)
disable_stdin = true
Stdin is /dev/null while evaluating
bash_path = "<path>"
Fixed path to bash
Recipes
# .envrclayout python3dotenv_if_exists.env.local# then:direnv allow# sub/.envrcsource_upexport SERVICE=apiPATH_add scripts# .envrcwatch_file flake.nix flake.lockuse flake# .envrcenv_vars_required API_TOKENdotenv# git: ignore .env and .direnv/
