WhatTheCommit 项目技术文档

1. 安装指南

WhatTheCommit 是一个从 whatthecommit.com 获取随机且有趣的提交信息的命令行客户端。要快速开始使用，请执行以下命令：

# 安装到 /usr/local/bin/whatthecommit
curl -L https://github.com/lwe/whatthecommit/raw/master/whatthecommit >/usr/local/bin/whatthecommit
chmod 0755 /usr/local/bin/whatthecommit

以上命令将会下载脚本并设置为可执行，然后将其安装到 /usr/local/bin/ 目录下。

2. 项目的使用说明

WhatTheCommit 的使用非常简单，在命令行中直接输入 whatthecommit 命令即可获取一个随机且滑稽的提交信息。

如果你不想在提交信息中看到由 whatthecommit.com 提供的版权信息，可以在命令中加入 -n 参数。

whatthecommit -n

如果你想要获取多个提交信息，可以使用 -i 参数并指定数量：

whatthecommit -i 3

3. 项目API使用文档

WhatTheCommit 本身不提供API，但它使用的数据源 whatthecommit.com 提供了一个简单的文本接口，位于 https://whatthecommit.com/index.txt。你可以直接通过 curl 命令访问这个接口来获取一个随机的提交信息：

curl --silent --fail https://whatthecommit.com/index.txt

4. 项目安装方式

除了通过上述的 curl 命令安装 WhatTheCommit 外，还有其他几种方式可以使用 whatthecommit.com 的数据：

• 在你的 .bashrc、.zshrc 或者其他 shell 配置文件中创建一个函数：

function whatthecommit() {
  curl --silent --fail https://whatthecommit.com/index.txt
}

• 设置一个 git 别名：

git config --global alias.yolo '!git add -A && git commit -m "$(curl --silent --fail https://whatthecommit.com/index.txt)"'

以上两种方式不需要安装 WhatTheCommit 脚本，而是直接通过 curl 调用 whatthecommit.com 的文本接口。