Unclutter your .profile
Permalink
Failed to load latest commit information.
.github github: add issue template Dec 20, 2017
docs Add manpage for config.toml. (#337) Feb 20, 2018
man Document possibility to unset vars (#392) Sep 9, 2018
script remove ruby as a build dependency Oct 16, 2017
test Overhaul the build system (#375) Jul 8, 2018
vendor/github.com Add a TOML configuration file, support whitelisting envrc's regardles… Feb 20, 2018
.gitignore Overhaul the build system (#375) Jul 8, 2018
.nojekyll New site: put the doc inside the project so it stays in sync Jun 12, 2014
.travis.yml Overhaul the build system (#375) Jul 8, 2018
CHANGELOG.md Release v2.17.0 Jun 17, 2018
CNAME New site: put the doc inside the project so it stays in sync Jun 12, 2014
GNUmakefile make: don't make shfmt a dependency Aug 20, 2018
Gopkg.lock go dep: update Gopkg.lock Aug 20, 2018
Gopkg.toml use the new `dep` tool to manage dependencies Sep 7, 2017
LICENSE.md Update repo urls to point to the new org Jun 27, 2015
README.md Correctes spelling of openSUSE (#403) Oct 9, 2018
cmd_allow.go Add a TOML configuration file, support whitelisting envrc's regardles… Feb 20, 2018
cmd_apply_dump.go Only backup the diff of environments. Fixes #82 Jan 11, 2014
cmd_current.go Handle `direnv current` with no argument May 19, 2016
cmd_deny.go Add a TOML configuration file, support whitelisting envrc's regardles… Feb 20, 2018
cmd_dotenv.go dotenv: move to vendor folder Sep 3, 2017
cmd_dump.go WATCHES passes all tests Mar 13, 2016
cmd_edit.go Add a TOML configuration file, support whitelisting envrc's regardles… Feb 20, 2018
cmd_exec.go Add a TOML configuration file, support whitelisting envrc's regardles… Feb 20, 2018
cmd_expand_path.go Display command arguments in the help Apr 1, 2013
cmd_export.go Simplify ranges without values Jun 21, 2016
cmd_help.go Add command aliases. `direnv --help` is an alias to `direnv help` Dec 24, 2013
cmd_hook.go hook: pin the direnv path Jun 7, 2018
cmd_prune.go prune: better desc Mar 26, 2016
cmd_reload.go Fix `go vet` warnings Jun 21, 2016
cmd_show_dump.go direnv show_dump: new command to debug encoded env (#395) Sep 17, 2018
cmd_status.go Simplify ranges without values Jun 21, 2016
cmd_stdlib.go Overhaul the build system (#375) Jul 8, 2018
cmd_version.go Add alias '--version' to version command. Closes #377. (#404) Oct 11, 2018
cmd_watch.go refactor shells Mar 26, 2016
commands.go direnv show_dump: new command to debug encoded env (#395) Sep 17, 2018
config.go hook: pin the direnv path Jun 7, 2018
const.go Fixing "lagging" on first entry Mar 20, 2016
default.nix hook: pin the direnv path Jun 7, 2018
env.go add a configurable DIRENV_WARN_TIMEOUT option (#273) May 8, 2017
env_diff.go refactor shells Mar 26, 2016
env_diff_test.go Fix `go vet` warnings Jun 21, 2016
env_test.go Fix `go vet` warnings Jun 21, 2016
file_times.go also reload when mtime goes back in time Aug 15, 2017
file_times_test.go File times impl working, tested Mar 10, 2016
index.html website: update ditto to v0.15 Dec 8, 2017
log.go Only output color if $TERM is not dumb (#264) Mar 24, 2017
look_path.go Try to detect an editor in the PATH if EDITOR is not set. Jun 15, 2014
main.go Build-time bash path Apr 4, 2016
marshal.go File times impl working, tested Mar 10, 2016
rc.go config: allow to disable stdin on eval (#351) Mar 24, 2018
rc_test.go If two paths don't have a common ancestors, don't make them relative. Feb 28, 2014
shell.go direnv: add support for elvish (#357) Apr 25, 2018
shell.nix testing: elvish 0.12 is released now (#402) Oct 4, 2018
shell_bash.go Avoid to add unnecessary trailing semicolon character (#384) Aug 1, 2018
shell_elvish.go hook: pin the direnv path Jun 7, 2018
shell_fish.go hook: pin the direnv path Jun 7, 2018
shell_json.go direnv export json: a new universal format Mar 26, 2016
shell_tcsh.go hook: pin the direnv path Jun 7, 2018
shell_test.go refactor shells Mar 26, 2016
shell_vim.go refactor shells Mar 26, 2016
shell_zsh.go hook: pin the direnv path Jun 7, 2018
stdlib.go stdlib: fix typo Sep 6, 2018
stdlib.sh stdlib: fix typo Sep 6, 2018
version.go Release v2.17.0 Jun 17, 2018
version.txt Release v2.17.0 Jun 17, 2018
xdg.go Still WIP but approaching a workable state Feb 7, 2013

README.md

direnv -- Unclutter your .profile

Built with Nix Build Status

direnv is an environment switcher for the shell. It knows how to hook into bash, zsh, tcsh, fish shell and elvish to load or unload environment variables depending on the current directory. This allows project-specific environment variables without cluttering the ~/.profile file.

Before each prompt, direnv checks for the existence of a ".envrc" file in the current and parent directories. If the file exists (and is authorized), it is loaded into a bash sub-shell and all exported variables are then captured by direnv and then made available to the current shell.

Because direnv is compiled into a single static executable, it is fast enough to be unnoticeable on each prompt. It is also language-agnostic and can be used to build solutions similar to rbenv, pyenv and phpenv.

Example

$ cd ~/my_project
$ echo ${FOO-nope}
nope
$ echo export FOO=foo > .envrc
.envrc is not allowed
$ direnv allow .
direnv: reloading
direnv: loading .envrc
direnv export: +FOO
$ echo ${FOO-nope}
foo
$ cd ..
direnv: unloading
direnv export: ~PATH
$ echo ${FOO-nope}
nope

Install

From system packages

direnv is packaged for a variety of systems:

See also:

Packaging status

From binary builds

Binary builds for a variety of architectures are also available for each release.

Fetch the binary, chmod +x direnv and put it somewhere in your PATH.

Compile from source

Setup go environment https://golang.org/doc/install

go >= 1.9 is required

Clone project:

$ git clone git@github.com:direnv/direnv.git

Build by just typing make:

$ cd direnv
$ make

To install to /usr/local:

$ make install

Or to a different location like ~/.local:

$ make install DESTDIR=~/.local

Setup

For direnv to work properly it needs to be hooked into the shell. Each shell has its own extension mechanism:

BASH

Add the following line at the end of the ~/.bashrc file:

eval "$(direnv hook bash)"

Make sure it appears even after rvm, git-prompt and other shell extensions that manipulate the prompt.

ZSH

Add the following line at the end of the ~/.zshrc file:

eval "$(direnv hook zsh)"

FISH

Add the following line at the end of the ~/.config/fish/config.fish file:

eval (direnv hook fish)

TCSH

Add the following line at the end of the ~/.cshrc file:

eval `direnv hook tcsh`

Elvish (0.12+)

Run:

$> direnv hook elvish > ~/.elvish/lib/direnv.elv

and add the following line to your ~/.elvish/rc.elv file:

use direnv

Usage

In some target folder, create a ".envrc" file and add some export(1) directives in it.

Note that the contents of the .envrc file must be valid bash syntax, regardless of the shell you are using. This is because direnv always executes the .envrc with bash (a sort of lowest common denominator of UNIX shells) so that direnv can work across shells. If you try to use some syntax that doesn't work in bash (like zsh's nested expansions), you will run into trouble.

On the next prompt you will notice that direnv complains about the ".envrc" being blocked. This is the security mechanism to avoid loading new files automatically. Otherwise any git repo that you pull, or tar archive that you unpack, would be able to wipe your hard drive once you cd into it.

So here we are pretty sure that it won't do anything bad. Type direnv allow . and watch direnv loading your new environment. Note that direnv edit . is a handy shortcut that opens the file in your $EDITOR and automatically allows it if the file's modification time has changed.

Now that the environment is loaded, you will notice that once you cd out of the directory it automatically gets unloaded. If you cd back into it, it's loaded again. That's the basis of the mechanism that allows you to build cool things.

The stdlib

Exporting variables by hand is a bit repetitive so direnv provides a set of utility functions that are made available in the context of the ".envrc" file.

As an example, the PATH_add function is used to expand and prepend a path to the $PATH environment variable. Instead of export $PATH=$PWD/bin:$PATH you can write PATH_add bin. It's shorter and avoids a common mistake where $PATH=bin.

To find the documentation for all available functions check the direnv-stdlib(1) man page.

It's also possible to create your own extensions by creating a bash file at ~/.config/direnv/direnvrc or ~/.direnvrc. This file is loaded before your ".envrc" and thus allows you to make your own extensions to direnv.

Loading layered .envrc

Let's say you have the following structure:

  • "/a/.envrc"
  • "/a/b/.envrc"

If you add the following line in "/a/b/.envrc", you can load both of the ".envrc" files when you are in /a/b:

source_env ..

In the general case source_up will load any .envrc higher up in the folder structure. This allows you to truely enable arbitrary heirarchical stuctures of .envrc usage.

source_up

Common things people don't know

Based on GitHub issues interractions, here are the top things that have been confusing for users:

  1. direnv has a standard library of functions, a collection of utilities that I found useful to have and accumulated over the years. If you know how to read bash, you can find it here: https://github.com/direnv/direnv/blob/master/stdlib.sh

  2. It's possible to override the stdlib with your own set of function by adding a bash file to either ~/.config/direnv/direnvrc or ~/.direnvrc. These will become available to all your .envrc files.

  3. direnv is actually creating a new bash process to load the stdlib, direnvrc and .envrc, and only exports the environment diff back to the original shell. This allows direnv to record the environment changes accurately and also work with all sorts of shells. It also means that aliases and functions are not exportable right now.

Similar projects

  • Environment Modules - one of the oldest (in a good way) environment-loading systems
  • autoenv - lightweight; doesn't support unloads
  • zsh-autoenv - a feature-rich mixture of autoenv and smartcd: enter/leave events, nesting, stashing (Zsh-only).
  • asdf - a pure bash solution that has a plugin system

Contribute

Bug reports, contributions and forks are welcome.

All bugs or other forms of discussion happen on http://github.com/direnv/direnv/issues.

There is a wiki available where you can share your usage patterns or other tips and tricks https://github.com/direnv/direnv/wiki

For longer form discussions you can also write to mailto:direnv-discuss@googlegroups.com

Or drop by on IRC (#direnv on freenode) to have a chat. If you ask a question make sure to stay around as not everyone is active all day.

Build Status

COPYRIGHT

Copyright (C) 2014 shared by all contributors under the MIT licence.