什么是 dotfiles

In Unix-like operating systems, any file or folder that starts with a dot character (for example, /home/user/.config), commonly called a dot file or dotfile.
任何以 . 開頭去命名的文件或者目錄都可以稱為 dotfile, 在 Unix-like 系統(tǒng)一般用的比較多, 但現(xiàn)在 dotfile 一般用于管理應(yīng)用/軟件的配置, 所以 Windows 平臺上也可以看到 dotfile 的身影.

什么是 chezmoi

chezmoi 是使用 Go 編寫的跨平臺 dotfiles 管理工具, 使用同一的 Git 倉庫進行配置同步, 可以很方便的幫助我們在多個開發(fā)環(huán)境共用一套配置, 免去一些同一工具鏈需要手工重新在多個機器配置的工作量.

開源社區(qū)流行的 dotfiles 管理工具很多, 我們可以在這個網(wǎng)站上可以看到: https://dotfiles.github.io/utilities/.

本篇文章主要介紹使用 chezmoi 進行 dotfiles 管理的一些基本流程, 還會介紹如何使用 vscode 配置 chezmoi 讓配置管理體驗更好的一些小技巧.

chezmoi 管理 dotfile 工作流

# 在使用 chezmoi 時, 需要先安裝 chezmoi, 可以參考: https://www.chezmoi.io/install
sh -c "$(curl -fsLS get.chezmoi.io)"
# 安裝完后初始化 chezmoi 的工作目錄
chezmoi init
# 使用 chezmoi cd 可以直接切換到工作目錄
chezmoi cd 
# 然后使用 git 將工作目錄和代碼倉庫關(guān)聯(lián)起來即可
git init
git remote add origin <your-git-repo>

官方文檔也給出了使用 chezmoi 管理 dotfile 的工作流大概是怎么樣的, 這里稍作解釋:

chezmoi workflow

我們以 .bashrc 文件的管理為例子:

# Step 1、將 .bashrc 文件納入 chezmoi 管控范圍
# chezmoi 會將該文件拷貝到 chezmoi 工作目錄下, 會重命名為 dot_bashrc, 使用 dot 替換 .
chezmoi add .bashrc
# .bashrc 文件納入管控之后, 就不應(yīng)該在修改配置的時候編輯 .bashrc 文件了, 而是編輯 chezmoi 工作目錄下的 dot_bashrc 文件
# 可以切換去工作目錄查看下
chezmoi cd
ls -al
# Step 2、配置的修改我們可以使用如下命令去修改, chezmoi 會使用文本編輯器打開對應(yīng)的 dot_bashrc 文件
chezmoi edit ~/.bashrc
# Step 3、配置修改后是還沒有應(yīng)用到 .bashrc 文件的, diff 命令可以用來查看修改情況
chezmoi diff ~/.bashrc
# Step 4、想應(yīng)用修改后的配置可以使用 apply 命令
chezmoi apply ~/.bashrc
# 至此已經(jīng)基本完成一次 dotfile 的管理, 但為了想要在其他機器也使用這此改動, 是需要使用 git 做一次配置同步的

chezmoi 使用的一些小技巧與配置建議

1、替換 chezmoi edit 使用的默認編輯器為 vscode

chezmoi edit 默認根據(jù) EDITOR 環(huán)境變量決定使用什么編輯器打開文件, 我們可以修改 chezmoi 的配置文件改變 chezmoi 文件的行為, 配置文件一般在 ~/.config/chezmoi 目錄下, 參考配置如下:

# 控制 chezmoi edit 命令使用的編輯器, code --wait 會確保文件關(guān)閉再繼續(xù)
# 配置文件在:  ~/.config/chezmoi/chezmoi.toml
[edit]
    command = "code"
    args = ["--wait"]

tips: chezmoi apply 應(yīng)用修改后的配置時, 會根據(jù) chezmoi 工作目錄的層級去覆蓋 HOME 目錄對應(yīng)的文件

2、替換 chezmoi diff 使用的 diff 工具為 vscode

萬物皆可 vscode, 如果你想使用 vscode 的 dif 能力怎么辦, 這里直接給出 chemoi 的參考配置:

# https://github.com/twpayne/chezmoi/discussions/2424
[diff]
command = "code"
args = ["--wait", "--diff", "{{ .Destination }}", "{{ .Target }}"]

[merge]
command = "bash"

3、敏感數(shù)據(jù)存儲

如果你想用 chezmoi 管理你的密鑰（例如: id_rsa ssh 密鑰），同時又想把你的 dotfiles 配置在 GitHub 共享出來，chezmoi 自帶了敏感數(shù)據(jù)存儲的方案，可以使用 GPG、AGE 等對配置文件進行加密, 參考: https://www.chezmoi.io/user-guide/encryption/

本文由博客群發(fā)一文多發(fā)等運營工具平臺 OpenWrite 發(fā)布