首页/开发/Git 与协作速查/git help 获取帮助
Git 基础与命令88 条

git help 获取帮助

查阅文档:git help <命令> 打开手册页,git <命令> -h 快速查看选项,git help -a 列出全部命令。

Git 与协作速查开发更新于 2026-10-13

git help 是什么

查阅 Git 文档的入口:git help <命令> 打开完整手册页,git <命令> -h 快速看常用选项,git help -a 列出全部命令、git help -g 列出指南文章。离线环境下它是一手且与本地版本严格对应的参考,比记忆选项或搜索网页更可靠。

基本信息

手册git help <命令>(完整文档,等同 git <命令> --help)
快速参考git <命令> -h(仅常用选项摘要)
索引git help -a 全部命令;git help -g 指南列表
网页版git help -w <命令> 在缺手册环境打开网页文档
配置help.format 控制帮助的默认呈现方式
版本对齐手册内容与本地 Git 版本一致,升级后选项可能有增删

典型使用场景

  • 忘了选项细节:先 -h 快速确认参数拼写,再用 help 看完整语义。
  • 离线服务器:没有网页可查时,手册页是唯一与本地版本一致的参考。
  • 脚本编写:确认某选项在本地版本是否存在,避免写出跨版本不兼容的用法。
  • 排查差异:不同 Git 版本行为不同,用本地手册核对当前版本的准确描述。
  • 新人上手:help -g 的指南(如 revisions、workflows)是系统学习的入口。
  • 找命令:git help -a 配合分页搜索按关键词定位辅助命令。
  • 对照手册:两个版本行为不一致时,比对各自手册里的选项说明来定位差异来源。

常用示例

常用示例
git help commit            # 打开 commit 的完整手册(等同 git commit --help)
git commit -h              # 只显示常用选项概要,快速回顾
git help -a | head         # 列出全部命令(含辅助命令)
git help -g                # 列出指南:revisions、workflows 等
git help -w commit         # 无 man 环境时打开网页版帮助
git config --global help.format web   # 切换帮助的默认呈现方式

帮助入口对照

入口内容适用
git help <cmd>完整手册:语义、选项、示例深入理解某命令
git <cmd> -h摘要式用法与选项列表快速回忆参数
git help -a全部命令清单找命令名
git help -g指南文章列表系统学习概念
Windows 缺 man 环境时按提示配置 help.format 或用 -w 打开网页版;-h 只覆盖常用选项,细节与边界行为仍要查完整手册。

易错点

  • Windows 缺 man 环境直接执行 help 会报错,先配置 help.format 或养成用 -w 打开网页版的习惯。
  • -h 只列常用选项,隐藏选项与边界行为不显示,写脚本时以完整手册为准;遇到 -h 里没出现的参数,先查完整手册确认拼写。
  • 手册页跟随本地版本,跨版本复制用法前先确认选项存在,避免脚本在老环境报错。
  • 帮助里的示例假设在仓库根目录执行,子目录里跑相同命令前先确认路径语义。

数据来源与参考

  • Git 官方文档:git-help
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌