【direnv】ディレクトリごとに環境変数を管理する

direnv を使うメリット

ディレクトリごとに環境変数を変えたい場合があります。
例えば、複数のプロジェクト（サービス）を管理しているときなどです。

もう少し具体的にいうと、 Terraform などで管理している別々の AWS アカウントがあったとします。

このとき、それぞれを実行する IAMキー が共通であれば問題はないのですが、普通は別になっていると思います。
ローカルから Terraform を実行するとして、それぞれ IAMキーを切り替えるには　「~/.aws/config, ~/.aws/credentials」などで調整はできますが少々面倒です。

そんなとき direnv があると便利です。

direnv を使う

direnv は go で実装されています。 ( リポジトリ: https://github.com/zimbatm/direnv )

1. Mac を使用しているなら brew でインストールできます
   
   % brew install direnv ==> Downloading https://homebrew.bintray.com/bottles/direnv-2.17.0.high_sierra.bottle.tar.gz ######################################################################## 100.0% ==> Pouring direnv-2.17.0.high_sierra.bottle.tar.gz ? /usr/local/Cellar/direnv/2.17.0: 9 files, 5.4MB %

   1 2 3 4 5 6 7

   % brew install direnv   ==> Downloading https://homebrew.bintray.com/bottles/direnv-2.17.0.high_sierra.bottle.tar.gz ######################################################################## 100.0% ==> Pouring direnv-2.17.0.high_sierra.bottle.tar.gz ?  /usr/local/Cellar/direnv/2.17.0: 9 files, 5.4MB %

2. 次に 「~/.zshrc」に以下を追加します。※ お使いのシェル、エディタに合わせてください。
   
   export EDITOR=vim eval "$(direnv hook zsh)"

   1 2	export EDITOR=vim eval "$(direnv hook zsh)"

   
   変更後は「source ~/.zshrc」で再読込してください。
3. 次に環境変数を切り替えたい場所で以下を実行し、環境変数を記載します
   
   % direnv edit . ============ 以下、環境変数を記載して保存============ export AWS_ACCESS_KEY_ID="xxxxxxxxxxxxxxx" export AWS_SECRET_ACCESS_KEY="xxxxxxxxxxxxxxxxxxxxx" ========================================== direnv: loading .envrc direnv: export +AWS_ACCESS_KEY_ID +AWS_SECRET_ACCESS_KEY %

   1 2 3 4 5 6 7 8 9

   % direnv edit .   ============ 以下、環境変数を記載して保存============ export AWS_ACCESS_KEY_ID="xxxxxxxxxxxxxxx" export AWS_SECRET_ACCESS_KEY="xxxxxxxxxxxxxxxxxxxxx" ========================================== direnv: loading .envrc direnv: export +AWS_ACCESS_KEY_ID +AWS_SECRET_ACCESS_KEY %

4. 確認します
   
   % pwd /Users/user1/terraform/terraform-service1 % ls -la . total 8 drwxr-xr-x 5 user1 staff 160 9 19 23:55 ./ drwxr-xr-x 5 user1 staff 160 9 19 23:37 ../ -rw-r--r-- 1 user1 staff 96 9 19 23:54 .envrc -------> ファイルができている drwxr-xr-x 2 user1 staff 64 9 19 23:37 modules/ drwxr-xr-x 2 user1 staff 64 9 19 23:38 workspace/ % env | grep AWS -----------> 環境変数がセットされています AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxx AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxx

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

   % pwd   /Users/user1/terraform/terraform-service1 % ls -la .   total 8 drwxr-xr-x  5 user1  staff  160  9 19 23:55 ./ drwxr-xr-x  5 user1  staff  160  9 19 23:37 ../ -rw-r--r--  1 user1  staff   96  9 19 23:54 .envrc                  -------> ファイルができている drwxr-xr-x  2 user1  staff   64  9 19 23:37 modules/ drwxr-xr-x  2 user1  staff   64  9 19 23:38 workspace/     % env | grep AWS                                                  -----------> 環境変数がセットされています   AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxx AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxx

   
   「.envrc」というファイルが作成され、環境変数が読まれているのが分かると思います。直接ファイルを修正することも可能です。
   このファイルがあるディレクトリ配下に影響があるということも確かめてみます。（上位のディレクトリに移動すると環境変数がアンセットされます）
   
   % cd .. direnv: unloading % env | grep AWS % cd terraform-service1 direnv: loading .envrc direnv: export +AWS_ACCESS_KEY_ID +AWS_SECRET_ACCESS_KEY % cd workspace % env | grep AWS AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxx AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxx

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

   % cd ..   direnv: unloading % env | grep AWS   % cd terraform-service1   direnv: loading .envrc direnv: export +AWS_ACCESS_KEY_ID +AWS_SECRET_ACCESS_KEY % cd workspace   % env | grep AWS   AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxx AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxx

まとめ

以上で direnv の使い方の紹介は終わりです。
環境変数の扱いにはいろんなソリューションがあると思いますが、 direnv はその一つとして検討してもよい便利で簡単に使用できるツールだと思います。
多くの場面で活躍するものだと思うのでぜひ試してみてください。

補足

vim などで修正してコメント文などを入れた場合など以下のようなエラーが出ると思います。
問題がなければ指示通り direnv allow コマンドを実行して問題ありません。