mirror of
https://github.com/d0zingcat/dotfiles.git
synced 2026-05-29 23:16:50 +00:00
docs: 更新备份相关文档说明
更新内容: - README.md: 更新 backup 命令说明,添加备份功能详细章节 - QUICKSTART.md: 添加离职前备份步骤 - CHECKLIST.md: 添加备份检查清单 - MIGRATION_GUIDE.md: 添加详细备份流程和离职前检查 - BACKUP_INSTRUCTIONS.md: 新建完整备份指南(离职前必读) 文档改进: - 明确标注哪些文件可以提交,哪些不能提交 - 添加备份报告解读说明 - 添加安全清单和离职检查项 - 添加常见问题解答
This commit is contained in:
49
README.md
49
README.md
@@ -43,7 +43,7 @@ brew bundle install
|
||||
|------|------|
|
||||
| `./setup.sh init` | 初始化新系统 (Homebrew, Xcode, antigen) |
|
||||
| `./setup.sh install` | 安装 dotfiles 软链接 |
|
||||
| `./setup.sh backup` | 备份当前配置到 Brewfile |
|
||||
| `./setup.sh backup` | **完整备份** (Brewfile + Git 配置+SSH 公钥 +VSCode 扩展) |
|
||||
| `./setup.sh sync` | 从 git 仓库同步最新配置 |
|
||||
| `./setup.sh full-recover` | 新机器完整恢复 (init + install + sync) |
|
||||
| `./setup.sh check` | 检查当前安装状态 |
|
||||
@@ -300,3 +300,50 @@ MIT
|
||||
- [迁移检查清单](./CHECKLIST.md)
|
||||
- [Neovim 配置](./nvim/README.md)
|
||||
- [Dotfiles 迁移计划](./.sisyphus/plans/dotfiles-migration.md)
|
||||
|
||||
---
|
||||
|
||||
## 💾 备份功能
|
||||
|
||||
`./setup.sh backup` 会备份以下配置:
|
||||
|
||||
### 备份内容
|
||||
|
||||
| 项目 | 说明 | 是否可提交 |
|
||||
|------|------|-----------|
|
||||
| **Brewfile** | Homebrew 包列表 | ✅ |
|
||||
| **SSH 公钥** | `~/.ssh/*.pub` | ⚠️ 不提交 |
|
||||
| **Git 配置摘要** | 用户信息(脱敏) | ⚠️ 不提交 |
|
||||
| **1Password 配置** | SSH Agent 设置 | ✅ |
|
||||
| **VSCode 扩展** | 已安装扩展列表 | ✅ |
|
||||
| **备份报告** | 完整备份状态 | ✅ |
|
||||
|
||||
### 使用方式
|
||||
|
||||
```bash
|
||||
# 运行备份
|
||||
./setup.sh backup
|
||||
|
||||
# 查看备份报告
|
||||
cat .backup_report_*.md
|
||||
|
||||
# 提交安全文件
|
||||
git add Brewfile .1password_config.txt .vscode_extensions.txt
|
||||
git commit -m 'backup: update dotfiles'
|
||||
```
|
||||
|
||||
### 安全提醒
|
||||
|
||||
- ⚠️ **不要提交**: `.git_config_summary.txt`, `ssh_backup_*/`
|
||||
- ✅ **可以提交**: `Brewfile`, `.1password_config.txt`, `.vscode_extensions.txt`
|
||||
|
||||
---
|
||||
|
||||
## 📚 相关文档
|
||||
|
||||
| 文档 | 用途 |
|
||||
|------|------|
|
||||
| [BACKUP_INSTRUCTIONS.md](./BACKUP_INSTRUCTIONS.md) | **详细备份指南**(离职前必读) |
|
||||
| [MIGRATION_GUIDE.md](./MIGRATION_GUIDE.md) | 个人备份说明 |
|
||||
| [CHECKLIST.md](./CHECKLIST.md) | 配置检查清单 |
|
||||
| [QUICKSTART.md](./QUICKSTART.md) | 快速开始指南 |
|
||||
|
||||
Reference in New Issue
Block a user