/envy

💫 A magical little tool that takes care of your environment settings.

Primary LanguageRustApache License 2.0Apache-2.0

envy

...sets environment variables when you enter a directory that matches a regular expression.

Example

At work, I have to set some environment variables everytime I'm working on certain projects.
For example, these can be Google Cloud settings, the Consul host or Docker configs.

It's tedious to do that myself every time.

direnv automatically loads .env files, but I don't want to clutter my system
with .env files. Also I need the same environment variables in a few unrelated
projects and I don't want to keep the .env files in sync.

Thus, envy was born.

It uses a config file that defines, what environment variables to set when:

[[paths]]
pattern = ".*project1.*"
env = [
  "CONSUL_HTTP_ADDR=http://consul:8500"
]

[[paths]]
pattern = ".*project2.*"
env = [
  "DOCKER_HOST=tcp://127.0.0.1:2376",
  "foo=bar"
]

On macOS, this file is located at /Users/<user>/Library/Application Support/Envy/Config.toml.
The first regular expression that matches a path will be used.

Installation

cargo install envy-cli

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

eval "$(envy hook zsh)"

Once you load a new shell, envy will watch directories and set the specified
environment variables from the config file.

Limitations

  • Only supports zsh for now.
  • Only tested on macOS. Should also work on Linux and Windows, though.
  • Does not unset variables when you leave a directory yet.
  • Only developing this for myself. Thus, this project won't be very actively developed.