Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mre/envy
💫 Manage environment variables without cluttering your .zshrc.
https://github.com/mre/envy
cli direnv dotenv environment variables
Last synced: 5 days ago
JSON representation
💫 Manage environment variables without cluttering your .zshrc.
- Host: GitHub
- URL: https://github.com/mre/envy
- Owner: mre
- License: apache-2.0
- Created: 2019-03-09T22:43:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T04:21:58.000Z (11 days ago)
- Last Synced: 2024-10-24T16:28:05.641Z (10 days ago)
- Topics: cli, direnv, dotenv, environment, variables
- Language: Rust
- Homepage:
- Size: 379 KB
- Stars: 69
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# envy
Sets environment variables when you enter a directory.
Works with bash, zsh, and fish.
[](https://docs.rs/envy-cli/)
## Example
At work, I have to set some environment variables every time I'm working on certain projects.
For example, these can be Google Cloud settings, the Consul host, or Docker configs.
It's tedious to set the correct environment variables 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, the idea for `envy` was born.
It uses a config file that defines what environment variables to set for each folder.
## Installation
```
cargo install envy-cli
```
Add the following line to the end of your `~/.zshrc` file:
```zsh
eval "$(envy hook zsh)"
```
For bash, use `envy hook bash` instead and add it to your `~/.bashrc` file.
```bash
eval "$(envy hook bash)"
```
For fish, use `envy hook fish` instead and add it to your
`~/.config/fish/config.fish` file.
```fish
eval (envy hook fish)
```
Once you open a new shell, `envy` will start matching directories and set the
specified environment variables from the config file.
## Usage
Run `envy edit` to open the config file. (On macOS, this file is located at
`/Users//Library/Application Support/Envy/Config.toml`.)
Define the list of regular expressions and the settings.
The first regular expression that matches a path wins.
```toml
[[paths]]
pattern = ".*project1.*"
env = [
"CONSUL_HTTP_ADDR=http://consul:8500",
"GITHUB_TOKEN=123"
]
[[paths]]
pattern = ".*project2.*"
env = [
"DOCKER_HOST=tcp://127.0.0.1:2376",
"foo=bar"
]
```
The moment you save the file, the current terminal will automatically pick up
the new settings; no need to reload or open a new terminal. :v:
## direnv compatibility
`envy` supports loading environment files à la `direnv` as well. Run `envy allow
.env` to auto-load the `.env` file in the current path on enter. You can add
multiple `.env` files (e.g. `envy allow .envrc`). Duplicate keys will be
overwritten in the order of appearance in the envy config file (run `envy edit`
to modify order). Use `envy deny .env` to remove an environment file from the
list.
## Command-line options
```
envy 0.4.0
context-based environment variables
USAGE:
envy
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
allow Grants envy to load the given `.env` file
deny Revokes the authorization of a given `.env` file
edit Edit the envy config file
export Export environment variables based on the current directory
find Find a single environment variable and print its value
help Prints this message or the help of the given subcommand(s)
hook Print the hook to activate envy for your shell
load Load environment variables from a given `.env` file (for the current session only)
path Print path to envy config file
show Show envy config for current directory
```
Note: To load the environment variables into the current shell, you need to run `eval "$(envy load)"`.
## Limitations
- Only tested on macOS. It should also work on Linux and Windows, though.
- Does not unset variables when you leave a directory.
- Developing this for myself. Thus, this project won't be worked on very actively.
[direnv]: https://direnv.net/