sneivandt/dotfiles

Dotfiles ✨

基于Rust核心引擎的跨平台dotfiles管理系统，支持Linux、Arch Linux和Windows的基于配置文件的配置。

核心功能与特性

• 🦀 Rust核心引擎 — 快速、可靠的跨平台二进制文件
• 🎯 基于配置文件的配置管理
• 🔗 针对环境特定文件的Git稀疏检出
• 📦 通过TOML配置文件进行声明式包和符号链接管理
• 🔄 幂等安装（可安全重复运行）
• 📡 从GitHub Releases自动更新二进制文件
• 🤖 GitHub Copilot Agent Skills开发指导
• 🧪 全面的Rust测试套件和CI
• 🐳 用于隔离测试的Docker镜像

https://github.com/sneivandt/dotfiles/actions/workflows/release.yml/badge.svg](https://github.com/sneivandt/dotfiles/actions/workflows/release.yml) https://github.com/sneivandt/dotfiles/actions/workflows/docker.yml/badge.svg](https://github.com/sneivandt/dotfiles/actions/workflows/docker.yml) https://github.com/sneivandt/dotfiles/actions/workflows/ci.yml/badge.svg](https://github.com/sneivandt/dotfiles/actions/workflows/ci.yml)

快速开始

Linux

bash
git clone https://github.com/sneivandt/dotfiles.git
cd dotfiles
./dotfiles.sh install  # 提示选择配置文件

Windows

powershell
git clone https://github.com/sneivandt/dotfiles.git
cd dotfiles
.\dotfiles.ps1 install -p desktop

Docker

bash
docker run --rm -it sneivandt/dotfiles

工作原理

dotfiles系统包含三层结构：

1. 入口脚本（dotfiles.sh、dotfiles.ps1）— 轻量级包装器，从GitHub Releases下载最新二进制文件（或使用--build从源码构建）并转发所有参数。
2. Rust二进制文件（cli/）— 处理所有编排：配置解析、配置文件解析、符号链接、文件权限管理。仅在处理包管理器和系统服务时调用外部命令。
3. 配置（conf/）— 声明式TOML文件定义每个配置文件要安装的内容。

二进制文件自动更新：首次运行时，入口脚本引导二进制文件。之后，Rust二进制文件执行更新检查并维护版本缓存。在Windows上，PowerShell包装器还会在重新启动二进制文件前升级任何暂存的更新。

使用方法

bash
# 使用配置文件安装
./dotfiles.sh install -p desktop

# 预览更改（空运行）
./dotfiles.sh install -d

# 详细输出
./dotfiles.sh install -v

# 卸载（移除符号链接）
./dotfiles.sh uninstall

# 运行验证测试
./dotfiles.sh test

# 打印版本
./dotfiles.sh version

# 从源码构建并运行（开发）
./dotfiles.sh --build install -p base

详细用法请参见使用指南。

配置文件

配置文件控制包含哪些文件和安装哪些组件：

平台类别（linux、windows、arch）基于运行的操作系统自动检测。

详细信息请参见配置文件系统指南。

配置说明

配置在conf/*.toml文件中使用TOML格式定义：

• profiles.toml - 配置文件定义
• manifest.toml - 用于稀疏检出的文件到类别的映射
• symlinks.toml - 要符号链接到$HOME的文件
• packages.toml - 要安装的系统包
• systemd-units.toml - 要启用的Systemd单元
• vscode-extensions.toml - VS Code扩展
• copilot-plugins.toml - GitHub Copilot CLI插件
• git-config.toml - Git配置设置
• registry.toml - Windows注册表设置
• chmod.toml - 文件权限

详细格式文档请参见配置参考。

开发

bash
# 构建Rust二进制文件
cd cli && cargo build

# 运行测试
cargo test

# 代码检查
cargo clippy -- -D warnings

# 代码格式化
cargo fmt

# 从源码运行
./dotfiles.sh --build install -p base -d

开发指南请参见贡献指南。

测试

bash
# Rust测试（单元测试 + 集成测试）
cd cli && cargo test

# 验证配置
./dotfiles.sh test

CI工作流验证：cargo fmt、cargo clippy、cargo test、Linux和Windows构建、包装脚本的shellcheck、每个配置文件的集成测试。

详细测试流程请参见测试文档。

Docker

bash
docker run --rm -it sneivandt/dotfiles
docker buildx build -t dotfiles:local .

已发布镜像：https://hub.docker.com/r/sneivandt/dotfiles

文档

• 使用指南 - 安装和使用说明
• 配置文件系统 - 配置文件的理解和使用
• 配置参考 - 配置文件格式
• 架构 - Rust引擎设计和结构
• 贡献指南 - 开发工作流和指南
• 测试 - 测试流程和CI
• 故障排除 - 常见问题和解决方案
• Windows使用 - Windows特定文档
• Docker - Docker镜像使用和构建
• Git钩子 - 仓库Git钩子
• 安全 - 安全策略和最佳实践