如何为Git自定义别名添加类似原生命令的内置描述？

当然可以，有两种实用的方式给自定义别名添加类似原生命令的描述/帮助信息：

方式一：在别名中整合帮助逻辑 #

如果你的别名是映射Git原生命令（比如st对应status），可以让别名同时支持调用原命令的帮助文档：

git config --global alias.st '!git status --help || git status'

这样运行git st --help时会弹出git status的官方帮助，直接执行git st则正常运行状态查询。

要是你定义的是原创功能别名，还可以直接在别名里加入自定义提示：

git config --global alias.cleanup '!echo "功能：清理本地未跟踪文件与重置工作区" && git clean -df && git reset --hard'

执行别名前会先显示你写的描述文本。

方式二：添加自定义帮助文档 #

如果想要更正式的、类似原生命令的man风格帮助页，可以这么做：

1. 创建一个名为git-<别名>.txt的文件（比如git-st.txt），用man页面的格式编写详细描述；
2. 将文件放到Git的帮助文档目录，可通过git --help-path命令查看具体路径（通常是系统级的/usr/share/doc/git-doc/或用户级的~/.local/share/git/help/）；
3. 之后运行git help <别名>（比如git help st）就能看到你自定义的完整帮助内容。

内容的提问来源于stack exchange，提问作者Reflexive Oak