Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roxma/envrc-rs
Auto source bash .envrc of your workspace
https://github.com/roxma/envrc-rs
bash cd direnv environment shell-extension terminal
Last synced: about 2 months ago
JSON representation
Auto source bash .envrc of your workspace
- Host: GitHub
- URL: https://github.com/roxma/envrc-rs
- Owner: roxma
- License: mit
- Created: 2018-05-30T09:48:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-14T05:31:45.000Z (11 months ago)
- Last Synced: 2024-03-15T14:04:48.548Z (10 months ago)
- Topics: bash, cd, direnv, environment, shell-extension, terminal
- Language: Rust
- Homepage:
- Size: 22.5 KB
- Stars: 31
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# envrc - Auto source bash .envrc of your workspace
## Wny?
Firstly, [direnv](https://github.com/direnv/direnv) doesn't officially
[support alias](https://github.com/direnv/direnv/issues/73) at the moment.
Secondly,
> 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.
However, envrc is simpler. It spawns a new interactive bash and load `.envrc`.
When you `cd` out of the directory, the shell exits and returns terminal back
to the original shell.
## Install
- `cargo install envrc`
- Add `PROMPT_COMMAND='eval "$(envrc bash)"'` to the end of your bashrc
## Usage
```
$ mkdir foo
$
$ echo 'echo in foo directory' > foo/.envrc
$
$ cd foo
envrc: spawning new /bin/bash
envrc: loading [/home/roxma/test/envrc/foo/.envrc]
in foo directory
$
$ cd ..
envrc: exit [/home/roxma/test/envrc/foo/.envrc]
```
```
$ envrc
envrc 0.2
Rox Ma [email protected]
auto source .envrc of your workspace
USAGE:
envrc [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
allow Grant permission to envrc to load the .envrc
bash for bashrc: PROMPT_COMMAND='eval "$(envrc bash)"'
deny Remove the permission
help Prints this message or the help of the given subcommand(s)
prune Remove expired or non-existing-file permissions
```
Note: Take care of your background jobs before getting out of `.envrc`.
## .envrc tips
- `export WORKSPACE_DIR=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")` for
`.envrc` to locate its directory.
- `exec bash` to reload the modifed `.envrc`
## .bashrc config
```bash
# If the `.envrc` is allowed, but not sourced for 1d since last unload, It
# will be considered expired
export ENVRC_ALLOW_DURATION=$((60*60*24))
PROMPT_COMMAND='eval "$(envrc bash)"'
```
## Why not bash/python?
The first working commit is written in python. But there's noticeable time lag
with the python version on my PC. Rewriting it with perl doesn't help either.
Then I decided to switch to rust.
```
$ time envrc.py bash-prompt-command >/dev/null
real 0m0.079s
user 0m0.044s
sys 0m0.004s
```
I have also tried a pure bash implementation. It works better than the python
implementation, since most of the python overhead is its startup time. Most
of the bash overhead is fork/exec of sub-processes and it's way slower than
the rust implementation. Read [#1](https://github.com/roxma/envrc-rs/issues/1)
for more information.