https://github.com/liby/dotfiles
🔧 My development environment and config
https://github.com/liby/dotfiles
Last synced: about 1 year ago
JSON representation
🔧 My development environment and config
- Host: GitHub
- URL: https://github.com/liby/dotfiles
- Owner: liby
- Created: 2024-06-07T02:10:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T03:52:48.000Z (about 1 year ago)
- Last Synced: 2025-04-06T04:02:52.209Z (about 1 year ago)
- Language: Shell
- Homepage:
- Size: 47.9 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
简体中文 | English
My Dotfiles
> **Note**
>
> 这是我个人的 dotfiles 仓库，用于配置和管理我的开发环境。通过这个仓库，我可以轻松地在多台 Mac 之间保持一致的开发环境配置。
## 项目简介
本仓库包含了一系列配置文件和脚本，用于设置和管理我的开发环境，包括但不限于：
- Git 配置，如： [_.config/git_](https://github.com/liby/dotfiles/tree/main/.config/git)
- Homebrew 备份文件：[_Brewfile_](https://github.com/liby/dotfiles/blob/main/Brewfile)
- Shell 配置，如：[_.zshrc_](https://github.com/liby/dotfiles/blob/main/.zshrc)
- SSH 配置，如：[_.ssh/config_](https://github.com/liby/dotfiles/blob/main/.ssh/config)
- 开发环境的初始化脚本：[_.config/scripts/macos-bootstrap.zsh_](https://github.com/liby/dotfiles/blob/main/.config/scripts/macos-bootstrap.zsh)
- 终端配置，如：[_.config/starship_](https://github.com/liby/dotfiles/tree/main/.config/starship)
这些文件是通过 Git Bare Repo 来管理的，这种方法使我能在保持 `$HOME` 目录整洁的同时又能使用 Git 来管理配置文件。如果你对这其中的缘由感兴趣，又想了解使用 Git Bare Repo 管理 dotfiles 的更多信息，欢迎阅读我之前写的一篇[分享文档](https://note.itswhat.me/#/page/%E4%BD%BF%E7%94%A8%20git%20bare%20repo%20%E6%9D%A5%E7%AE%A1%E7%90%86%20dotfiles)。
## 安装说明
### 1. 克隆仓库
首先，克隆本仓库到本地：
```sh
git clone --bare $HOME/.dotfiles
```
### 2. 定义别名
为了更方便地管理 dotfiles，你可以添加以下别名到你的 shell 配置文件（如 _.zshrc_ 或 _.bashrc_）：
```sh
alias dot='$(command -v git) --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'
```
然后，重新加载你的 shell 配置：
```sh
source ~/.zshrc # 如果你使用的是 Zsh
# 或者
source ~/.bashrc # 如果你使用的是 Bash
```
### 3. 隐藏未跟踪文件
为了避免在使用 `dot` 命令时看到未跟踪的文件列表，可以使用以下命令：
```sh
dot config --local status.showUntrackedFiles no
```
如果不设置的话，执行 `dot status` 命令时会显示大量未跟踪的文件。这是因为 `$HOME` 目录下的文件默认都还没有被 Git 纳入管理，而我们实际上只需要管理特定的配置文件。
### 4. 检出文件
使用以下命令将仓库中的文件检出到你的 `$HOME` 目录：
```sh
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
```
可以先备份已有的配置文件：
```sh
mkdir -p .dotfiles-backup
dot checkout 2>&1 | egrep "\s+\." | awk {'print $1'} | xargs -I{} mv {} .dotfiles-backupp/{}
```
然后再次尝试检出文件：
```sh
dot checkout
```
## 使用方法
你可以使用以下命令来管理你的 dotfiles：
```sh
dot add ：添加文件到仓库
dot commit -m "message"：提交更改
dot remote add origin ：配置远程仓库
dot push -u origin ：推送 commit 到远程仓库，同时将远程仓库与本地的 branch 分支关联
dot push：推送更改到远程仓库
dot pull：从远程仓库拉取更新
```
## 快捷方式（可选）
以上步骤中包含了一些不常用的命令，步骤也较为繁琐，可能不太容易记住。为了简化这个过程，我们可以创建一个自动化脚本，就像 [The best way to store your dotfiles: A bare Git repository](https://www.atlassian.com/git/tutorials/dotfiles#:~:text=you%20can%20create%20a%20simple%20script) 中提到的做法：
1. 创建一个自动化脚本
2. 将其存储为代码片段，可以使用 https://paste.gg/ 之类的网站
3. 为其创建一个短链接
我自己也有一个用于配置开发环境的[初始化脚本](https://github.com/liby/dotfiles/blob/main/.config/scripts/macos-bootstrap.zsh)，当我拿到一台新的 Mac 时，只需要打开 Terminal.app，运行下面的命令即可完成开发环境的设置：
```sh
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。