fabiogibson / envrc-zsh-plugin

Oh-my-zsh plugin to automatically load or unload environment variables from .envrc file depending on the current directory.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

envrc-zsh-plugin

Oh-my-zsh plugin to automatically load or unload ENV variables from .envrc file depending on the current directory.

The biggest difference between this plugin and the oh-my-zsh bundled dotenv is that it unloads all variables when you leave the project's directory.

Quick start guide

Installation

First, download the plugin to your $ZSH_CUSTOM/plugins directory.

using curl

curl --create-dirs -o $ZSH_CUSTOM/plugins/envrc/envrc.plugin.zsh https://raw.githubusercontent.com/fabiogibson/envrc-zsh-plugin/master/envrc.plugin.zsh

using wget

mkdir -p $ZSH_CUSTOM/plugins/envrc && wget -O $ZSH_CUSTOM/plugins/envrc/envrc.plugin.zsh https://raw.githubusercontent.com/fabiogibson/envrc-zsh-plugin/master/envrc.plugin.zsh

Now, edit your ~/.zshrc and add "envrc" (without quotes) to your plugins list.

plugins=(git ... envrc)

Reload oh-my-zsh.

source ~/.zshrc

Usage

Create a file named ".envrc" inside your project directory containing a list of enviroment variables you need to be set when you cd in that directory.

The file shall contain one variable per line, in the following format:

VAR_NAME=VAR_VALUE

Your variables will be automatically set and unset every time you cd or leave a project directory.

About

Oh-my-zsh plugin to automatically load or unload environment variables from .envrc file depending on the current directory.

License:MIT License


Languages

Language:Shell 100.0%