Gas项目技术文档

1. 安装指南

Gas 是一款帮助您管理 git 提交作者的工具。如果您在使用同一台计算机时，需要在不同邮箱之间切换提交者身份（例如个人邮箱和工作邮箱），或者您在进行配对编程时，希望反映代码不仅仅是由您一个人编写的，Gas 可以帮助您在配对用户和常规用户之间切换。

安装 Gas 的最佳方式是使用 RubyGems：

$ [sudo] gem install gas

您也可以从源代码进行安装：

$ cd gas/
$ bundle
$ rake install

2. 项目的使用说明

内置命令

• add NICKNAME NAME EMAIL - 添加一个新的用户到 gas
• delete NICKNAME - 从 gas 中删除一个用户
• import NICKNAME - 将当前 .gitconfig 中的用户导入为 NICKNAME
• list - 列出所有用户
• plugins - 列出所有已安装的插件
• show - 显示当前用户
• use NICKNAME - 将具有 NICKNAME 的用户设置为当前用户

默认任务为列出作者：

$ gas
$ gas list

这将列出在 ~/.gas/gas.users 文件中设置的作者。

您可以通过以下命令为当前用户分配一个昵称并导入：

$ gas import current_user

添加作者的命令如下：

$ gas add walle "Fredrik Wallgren" [e-mail]

主要使用的命令是：

$ gas use walle

若要删除用户，使用以下命令：

$ gas delete walle

查看帮助：

$ gas -h

3. 项目API使用文档

Gas 的扩展遵循 git 的方式，任何在 PATH 中的名为 gas-yourplugin 的可执行文件都可以与 gas 一起使用。这意味着您可以用任何您喜欢的语言编写 Gas 的扩展，唯一需要做的就是将其放入 PATH。

若要扩展已存在的命令，创建一个名为 gas-yourplugin-existingcommand 的可执行文件，例如 gas-stats-use，它将在原始 use 命令执行时做一些操作。这也使得扩展插件成为可能，例如 gas-myplugin-stats 将扩展 stats 命令，如果已安装。

一个示例插件可以在 gas_stats 找到，它使用 ruby 编写并使用 rubygems 分发，但这不是必须的。它通过添加统计功能来扩展 gas 的内置命令，并添加了自身的功能（gas-stats）。

4. 项目安装方式

项目的安装方式在 "安装指南" 部分已详细说明，您可以通过 RubyGems 安装或从源代码安装。如需安装插件，可以参考以下命令：

$ gem install gas_stats
$ gem install gas_ssh

每个插件的安装方式可能略有不同，请参考插件的 README 文档进行安装。