環境變數切換利器 - direnv

Last updated on  Oct 4, 2022  in  Unix-like 命令列教學  by  Amo Chen  ‐ 2 min read

開發程式時常會設定各式各樣的環境變數,例如 DEBUG mode, PRODUCTION mode 等等環境變數,這時候除了在 .profile .bashrc 等檔案中設定好環境變數之外,還有另一種選擇 direnv

direnv 可以讓我們在切換資料夾時,自動設定好不同的環境變數,在離開資料夾時自動清除環境變數的設定,使用上相當方便。

Install direnv

在 Ubuntu 上安裝 direnv 很簡單,只要執行以下指令即可:

$ sudo apt-get install direnv

目前 direnv 也有支援 macOS ,所以也可以透過 Homebrew 安裝。

如果你習慣使用 bash ,在安裝完之後,需要在 ~/.bashrc 檔案中添加以下 1 行:

eval "$(direnv hook bash)"

如果是習慣使用 zsh 者,則是在 ~/.zshrc 添加以下 1 行:

eval "$(direnv hook zsh)"

其他 shell 詳見 文件

使用 direnv

direnv 的使用上也很簡單,只要在想自動設置環境變數的資料夾內新增 1 個 .envrc 檔案,並在裡面設置環境變數即可。

例如編者最近在練習撰寫 Golang 專案需要設定 GOPATH GOROOT 等環境變數,就會在 .envrc 中寫入:

export GOPATH=/YOUR/GO/PATH
export GOROOT=/YOUR/GO/ROOT/PATH

然而並非設置好 .envrc 就可以了,因為 direnv 考慮到安全性,避免有人竄改 .envrc 的內容後被 direnv 自動執行,因此任何變動都需要使用 direnv allow . 指令允許 .envrc 的自動執行。

所以整個 direnv 設置環節會像以下這樣:

$ cd your_project  # 切換資料夾
$ vim .envrc       # 新增 .envrc
$ direnv allow .   # 允許 .envrc 自動執行

設置好之後,如果要編輯並自動允許的話,可以使用 direnv edit . 指令,它會自動使用環境變數 $EDITOR 的編輯器打開 .envrc ,儲存之後自動允許 .envrc ,因此就不需要再執行一次 direnv allow .

如果要解除 .envrc 自動執行,可以使用 direnv deny . 指令。

配合 .env 使用

現在開發也很常使用 dotenv 相關的套件,讓程式自動載入 .env 檔案內的設定,自動設定好環境變數,達成跟 direnv 類似的效用。

不過 direnv 預設使用 .envrc 檔案載入設定,變成如果是有在使用 dotenv 的開發者,勢必要同時維護 2 個檔案才行,所幸 direnv 也提供設定可以讀取 .env 的內容。

步驟是只要建立一個 direnvrc 設定檔到路徑 ~/.config/direnv/direnvrc , 並設定內容如下:

[global]
load_dotenv = true

如此一來,就能 dotenv 與 direnv 共用 .env 檔案了!

注意事項

由於 direnv 有考慮到安全性的問題,因此 .envrc 裡可執行的 shell 指令是有限制的,並不是每種指令都能執行,目前只支援 export unset 等指令,如果要做到更多彈性的事情的話,建議還是使用 shell script 吧。

p.s. 更多 direnv 的用法可以用 direnv help 查看。

References

https://direnv.net/

對抗久坐職業傷害

研究指出每天增加 2 小時坐著的時間,會增加大腸癌、心臟疾病、肺癌的風險,也造成肩頸、腰背疼痛等常見問題。

然而對抗這些問題,卻只需要工作時定期休息跟伸展身體即可!

你想輕鬆改變現狀嗎?試試看我們的 PomodoRoll 番茄鐘吧! PomodoRoll 番茄鐘會根據你所設定的專注時間,定期建議你 1 項辦公族適用的伸展運動,幫助你打敗久坐所帶來的傷害!

贊助我們的創作

看完這篇文章了嗎? 休息一下,喝杯咖啡吧!

如果你覺得 MyApollo 有讓你獲得實用的資訊,希望能看到更多的技術分享,邀請你贊助我們一杯咖啡,讓我們有更多的動力與精力繼續提供高品質的文章,感謝你的支持!