简体中文 | English

My Dotfiles

Note

这是我个人的 dotfiles 仓库，用于配置和管理我的开发环境。通过这个仓库，我可以轻松地在多台 Mac 之间保持一致的开发环境配置。

项目简介

本仓库包含了一系列配置文件和脚本，用于设置和管理我的开发环境，包括但不限于：

• Claude Code 配置：.claude

• Git 配置：.config/git

• 终端配置：.config/starship

• 开发环境初始化脚本：.config/scripts/macos-bootstrap.zsh

• SSH 配置：.ssh/config

• Shell 配置：.zshrc

• Homebrew 备份文件：Brewfile

这些文件是通过 Git Bare Repo 来管理的，这种方法使我能在保持 $HOME 目录整洁的同时又能使用 Git 来管理配置文件。如果你对这其中的缘由感兴趣，又想了解使用 Git Bare Repo 管理 dotfiles 的更多信息，欢迎阅读我之前写的一篇分享文档。

安装说明

1. 克隆仓库

首先，克隆本仓库到本地：

git clone --bare <git_url> $HOME/.dotfiles

2. 定义别名

为了更方便地管理 dotfiles，你可以添加以下别名到你的 shell 配置文件（如 .zshrc 或 .bashrc）：

alias dot='$(command -v git) --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'

然后，重新加载你的 shell 配置：

source ~/.zshrc  # 如果你使用的是 Zsh
# 或者
source ~/.bashrc  # 如果你使用的是 Bash

3. 隐藏未跟踪文件

为了避免在使用 dot 命令时看到未跟踪的文件列表，可以使用以下命令：

dot config --local status.showUntrackedFiles no

如果不设置的话，执行 dot status 命令时会显示大量未跟踪的文件。这是因为 $HOME 目录下的文件默认都还没有被 Git 纳入管理，而我们实际上只需要管理特定的配置文件。

此外，bare repo 通过 core.excludesFile 指向 ~/.config/git/dotfiles-ignore（内容为通配符 *），用于忽略所有未追踪的文件。这可以防止 dot status -u 扫描整个 $HOME 目录（避免 macOS 隐私权限警告），同时也杜绝了意外追踪文件的可能。因此，添加新文件时需要使用 -f 参数强制添加：

dot add -f <file>

4. 检出文件

使用以下命令将仓库中的文件检出到你的 $HOME 目录：

dot checkout

如果遇到文件冲突，比如下面这种报错：

error: The following untracked working tree files would be overwritten by checkout:
  .zshrc
Please move or remove them before you can switch branches.
Aborting

可以先备份已有的配置文件：

mkdir -p .dotfiles-backup
dot checkout 2>&1 | egrep "\s+\." | awk {'print $1'} | xargs -I{} mv {} .dotfiles-backup/{}

然后再次尝试检出文件：

dot checkout

使用方法

你可以使用以下命令来管理你的 dotfiles：

dot add -f <file>：添加新文件到仓库（需要 -f 因为 core.excludesFile 忽略了所有文件）
dot commit -m "message"：提交更改
dot remote add origin <git_url>：配置远程仓库
dot push -u origin <branch>：推送 commit 到远程仓库，同时将远程仓库与本地的 branch 分支关联
dot push：推送更改到远程仓库
dot pull：从远程仓库拉取更新

快捷方式（可选）

以上步骤中包含了一些不常用的命令，步骤也较为繁琐，可能不太容易记住。为了简化这个过程，我们可以创建一个自动化脚本，就像 The best way to store your dotfiles: A bare Git repository 中提到的做法：

1. 创建一个自动化脚本

2. 将其存储为代码片段，可以使用 https://paste.gg/ 之类的网站

3. 为其创建一个短链接

我自己也有一个用于配置开发环境的初始化脚本，当我拿到一台新的 Mac 时，只需要打开 Terminal.app，运行下面的命令即可完成开发环境的设置：

curl -o /tmp/macos-bootstrap.zsh https://raw.githubusercontent.com/liby/dotfiles/main/.config/scripts/macos-bootstrap.zsh && chmod +x /tmp/macos-bootstrap.zsh && /tmp/macos-bootstrap.zsh

非常方便。

贡献指南

如果你有任何改进建议或发现了问题，欢迎提交 Issue 或 Pull Request。