Gut-Sync 技术文档

本文档将详细介绍如何安装、使用以及配置 Gut-Sync 项目，帮助用户更好地理解和运用这个实时双向文件夹同步工具。

1. 安装指南

通过 curlbash 安装

如果不考虑安全性，可以尝试运行以下命令：

bash -c 'S="3bceab0bdc63b2dd7980161ae7d952ea821a23e693cb74961b0d41f61f557489";T="/tmp/gut.sh";set -e;wget -qO- "https://www.tillberg.us/c/$S/gut-1.0.3.sh">$T; echo "$S  $T"|shasum -a256 -c-;bash $T;rm $T'

此命令将下载并安装正确的 gut Go 二进制文件到 /usr/local/bin/gut。

从源码安装

要从源码安装，首先需要安装 Go 编译器（版本 1.4 或更高）。Go 安装文档是一个很好的起点，如果您还没有设置 Go。

安装 Go 后，还需要设置您的 GOPATH。您可能只想使用默认设置：

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

然后运行以下命令安装 Gut-Sync：

go get github.com/tillberg/gut

默认情况下，Gut-Sync 将下载（并验证）预编译的二进制文件。您可以选择从源码构建这些文件，但需要相同的依赖（如 build-essentials、autoconf 等），这需要使用 --build-deps 参数。

2. 项目的使用说明

假设您想创建一对链接文件夹，本地为 ~/work，远程服务器为 [e-mail]:~/work2。打开终端并运行以下命令：

$ gut sync ~/work [e-mail]:~/work

此命令将在本地 ~/work 中设置 Gut 仓库，并将其克隆到远程服务器上的 ~/work2 目录，然后开始监视两端的文件系统变化。

在另一个终端中，您可以测试 Gut 的同步功能：

$ cd ~/work
$ git clone https://github.com/tillberg/gut.git
$ cd gut
$ rm util_test.go
$ git add . --all
$ git commit -m 'made all tests pass'

然后切换到另一台主机并查看更改。

$ cd ~/work2/gut
$ git log --stat
# ... <- 您应该能看到刚刚提交的更改
$ gut log --stat
# ... <- 您应该能看到 *所有* 文件更改记录，包括在 ~/work2/gut/.git/ 中的更改

3. 项目API使用文档

Gut-Sync 使用 Git 作为底层同步机制，因此大多数 Git 命令都可以在 Gut 仓库中使用。例如：

$ gut init        # 初始化 Gut 仓库
$ gut add .       # 添加更改的文件到暂存区
$ gut commit -m '提交信息'  # 提交更改
$ gut log         # 查看提交历史

请注意，Gut-Sync 使用了修改版的 Git，名为 Gut，以便能够遍历 .git 文件夹。

4. 项目安装方式

项目安装方式已在上述“安装指南”部分详细描述。

• 通过 curlbash 安装：使用上述提供的 curlbash 命令。
• 从源码安装：通过设置 GOPATH 和安装 Go 编译器，然后运行 go get github.com/tillberg/gut。

以上即为 Gut-Sync 的安装、使用和配置指南。希望这份文档能帮助您更好地使用 Gut-Sync 实现实时双向文件夹同步。