:tools direnv

Save (or destroy) the environment at your leisure

1. Description

This module integrates direnv into Emacs.

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.

1.2. Module flags

This module has no flags.

1.4. Hacks

  • Normally, the direnv environment is updated on post-command-hook. We’ve changed it to update on doom-switch-buffer-hook, doom-switch-window-hook and doom-switch-frame-hook instead.
  • Special direnv keywords/commands are highlighted in direnv-envrc-mode.
  • A fix has been applied to ensure flycheck searches for executables from within the direnv environment, if any.

2. Prerequisites

This module requires direnv.

2.1. MacOS

# ⎘
$ brew install direnv

2.2. Arch Linux

direnv is available on the AUR

# ⎘
$ yay -S direnv

2.3. NixOS

# ⎘
environment.systemPackages = [ pkgs.direnv ];

Or $ nix-env -i direnv.

3. TODO Usage

This module has no usage documentation yet. Write some?

4. TODO Configuration

This module has no configuration documentation yet. Write some?

5. Troubleshooting

5.1. direnv + nix is slow

Consider augmenting direnv with lorri, which will cache nix builds and speed up direnv tremendously:

# ⎘
services.lorri.enable = true;

6. TODO Appendix

This module has no appendix yet. Write one?