快速开始

本教程将引导您在 5 分钟内，为本地 Git 仓库配置并启用 GitLocker 强加密规则。

前置准备

1. 安装客户端：确保您已完成 GitLocker 客户端程序的下载与安装，并已将 gitl 命令加入到系统环境变量 PATH 中。
2. 初始化 Git 仓库：进入您需要加密的本地项目目录中：

   cd /path/to/your/repo
   git init
   

第一步：一键初始化

在您的本地仓库根目录下运行 init 命令：

gitl init

GitLocker 将自动为您执行以下初始化：

1. 检测当前仓库环境。
2. 注册 GitLocker 的 clean、smudge 过滤器以及自定义 merge 驱动。
3. 如果您使用 Personal Provider，它会在本地安全凭据库中生成一个高随机强度的对称主密钥。
4. 生成本地加密元配置文件 .gitlocker/config.json。

第二步：设定加密规则

通过 encrypt 命令定义需要加密保护的文件或目录。这类似于配置 .gitignore。

例如，如果您想加密 production 配置文件和 secrets 目录下的所有文件：

gitl encrypt "config/production.json" "secrets/**"

运行该命令后：

1. 规则将被自动追加并写入仓库根目录下的 .gitattributes 文件。
2. 配置会以如下类似声明呈现：

   config/production.json filter=gitl-filter diff=gitl-diff merge=gitl-merge
   secrets/** filter=gitl-filter diff=gitl-diff merge=gitl-merge
   

3. 您需要将 .gitattributes 提交进 Git：

   git add .gitattributes
   git commit -m "Configure GitLocker encryption rules"
   

第三步：透明提交与推送

现在，安全边界已搭建完毕。在后续的工作中，您可以像平常一样执行原生的 Git 命令！

1. 添加文件并提交：

   git add config/production.json secrets/api-key.env
   git commit -m "Secured database secrets"
   

   在您执行 git add / git commit 时，GitLocker 过滤器会自动在暂存区拦截这些敏感文件，并将其转换为高强度的 AES-256-GCM 密文。

2. 推送至远端：

   git push origin main
   

   远端服务器（如 GitHub）上保存的全部是彻底被加密的密文。任何未授权访问的人即使拿到代码，面对的也只是随机的二进制乱码！

第四步：本地检出 (自动解密)

当您（或其他经过密钥授权的团队成员）在本地拉取或检出代码时：

git checkout main

GitLocker 的 smudge 过滤器会自动在检出时提取匹配的密文，并在您的物理工作区中透明解密。您的编辑器和开发环境看到的就是完全正常的明文代码。

五分钟快速起步完成！现在您的 Git 仓库已获得军工级防篡改加固。