git help
Git コマンドのヘルプドキュメントを表示します。コマンドの使い方や利用可能なオプションを確認する際に使います。
構文
git help [<command>] [<doc>] git help は Git コマンドのドキュメント(マニュアルページ)を表示するコマンドです。コマンドのオプションや使い方を忘れたときに気軽に参照できます。
基本的な使い方
# git help だけで、よく使うコマンドと概要を表示
git help
# 特定のコマンドのヘルプを表示
git help commit
git help merge
# 短縮形(--help オプション)も同じ結果になる
git commit --help
コマンド一覧を表示する
# 利用可能なすべての Git コマンドを一覧表示
git help -a
# ガイド・チュートリアルの一覧を表示
git help -g
git help -g を実行すると gittutorial、gitworkflows などの公式ガイド名が表示されます。
例えば git help gittutorial で Git の入門チュートリアルを読むことができます。
表示形式を変える
# ブラウザでヘルプページを開く
git help -w commit
# man コマンド形式で表示(端末内で読める)
git help -m commit
# info コマンド形式で表示
git help -i commit
-w(--web)オプションを使うと、HTML 形式のドキュメントをブラウザで確認できます。図や表を含む見やすい形式で読めるため、じっくり調べたいときに便利です。
man ページの読み方
git help <command> で表示される man ページは、最初は読みにくく感じるかもしれません。主なセクションの意味を覚えておくと役立ちます。
NAME コマンド名と一行の説明
SYNOPSIS 構文(<> は必須、[] は省略可、| はいずれか一つ)
DESCRIPTION 詳細な説明
OPTIONS 各オプションの解説
EXAMPLES 使用例
SEE ALSO 関連コマンド
操作方法(less コマンドのキー操作):
j/k: 1行下 / 1行上にスクロールSpace: 1ページ下にスクロール/+ 検索語 : ページ内検索q: 終了
注意点
- ローカルの man ページが古い場合、インストールされている Git バージョンの情報が反映されます。最新情報は Git 公式ドキュメント を参照してください。
- Windows 環境では
-wオプションが使えない場合があります。Git for Windows の設定によって挙動が異なります。