ghar 项目技术文档

1. 安装指南

ghar 是一个可以帮助你使用 Git 管理你的 $HOME 目录的工具，它可以将你的配置文件根据主题或隐私性分为不同的 Git 仓库。下面是安装 ghar 的步骤：

1. 克隆 ghar 仓库：

   $ git clone https://github.com/philips/ghar.git
   

2. 将 ghar 的 bin 目录添加到系统路径中，这样你就可以在任何位置使用 ghar 命令：

   $ export PATH=$PATH:`pwd`/ghar/bin/ # 你可能希望将这一设置永久化
   

3. 如果需要 bash 的 Tab 补全功能，你可以将 ghar-bash-completion.sh 脚本移动到 /etc/bash_completion.d/ 目录下（这需要 root 权限），或者直接在 .bashrc 或 .bash_profile 文件中 source 这个脚本：

   $ . `pwd`/ghar/ghar-bash-completion.sh
   

2. 项目使用说明

使用 ghar 管理你的 dotfiles 是非常简单的。下面是创建和使用 ghar 仓库的基本步骤：

1. 创建一个名为 devel 的 ghar 仓库，用来存储你的 .vimrc 配置文件：

   $ cd ghar
   $ mkdir devel
   $ cd devel
   $ git init
   $ mv ~/.vimrc .
   $ git add .vimrc
   $ git commit -m "vimrc: 初始提交"
   $ ghar install
   

2. 安装完成后，你可以使用以下命令来验证安装状态：

   $ ghar install --status
   

3. 项目 API 使用文档

ghar 提供了以下命令来管理你的 dotfile 仓库：

• ghar install: 安装或更新当前仓库中的所有文件。
• ghar add <repository-url> <local-name>: 添加一个外部的 Git 仓库。
• ghar pull: 拉取所有仓库的最新更改。
• ghar install --status: 显示安装状态。

4. 项目安装方式

ghar 的安装方式如上所述，主要包括以下步骤：

1. 克隆 ghar 仓库。
2. 将 ghar 的 bin 目录添加到系统路径中。
3. （可选）设置 bash 的 Tab 补全。

以上步骤将帮助你成功安装并使用 ghar，从而更高效地管理你的配置文件。