Gitで、コミットメッセージを複数行で書く方法

​​Git​コマンドライン

git commit -m "件名" -m "本文" のように -m を2回付けると、件名と本文の間に空行が入った、2段落のコミットメッセージになります。変更の理由や補足をコミットメッセージの本文に書きたいときに、エディターを開かずにコマンド1行で済ませられる方法です。ほかに、引用符の中で改行する書き方、-F でファイルや標準入力から読む書き方、エディターで書く方法もあります。検証環境で git のコマンドを実行し、出力をそのまま載せています。

補足

検証環境は Ubuntu 24.04、Git 2.43.0、シェルは bash 5.2.21 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定しています。Windows のコマンドプロンプトや PowerShell、zsh などほかのシェル、VS Code などのエディターでの動きは試していません。

操作の前のリポジトリ

neko-app というリポジトリに、1行だけのメッセージのコミットが1つある状態から始めます。

console
$ git log
commit 7e817a63371d430dfe4dbdc35561d1ed25cafea8
Author: Neko <neko@example.com>
Date:   Thu Nov 12 09:50:00 2026 +0900

    トップページを作る

-m を2回以上付けて、件名と本文に分ける

style.css を足して、-m を3回付けてコミットしました。

console
$ git status --short
A  style.css

$ git commit -m "文字の色を決める" -m "本文の文字を濃い灰色にした。" -m "見出しの色は次のコミットで決める。"
[main 6a7e8c5] 文字の色を決める
 1 file changed, 1 insertion(+)
 create mode 100644 style.css

git log -1 で見ると、1つ目の -m が件名になり、2つ目と3つ目は空行で区切られた段落として入っています。

console
$ git log -1
commit 6a7e8c5ce18bdc5be3e8c74660f70d9d7a971cae
Author: Neko <neko@example.com>
Date:   Thu Nov 12 10:10:00 2026 +0900

    文字の色を決める
    
    本文の文字を濃い灰色にした。
    
    見出しの色は次のコミットで決める。

公式リファレンスの -m の説明にも、-m を複数付けると、それぞれの値が別の段落としてつながると書かれています。-m ごとに必ず空行が入ります。本文の中で、空行を挟まずに行を続けたいとき(箇条書きなど)は、この後で紹介する、引用符の中で改行する書き方か -F を使います。-m の中に \n と書く方法は、うまくいきません。

-m の中に \n と書いても改行にならない

-m の文字列の中に \n と書くと、改行ではなく、\n の2文字のまま記録されました。

console
$ git commit -q -m "見出しの色を決める\n\n水色にした。"

$ git log -1 --format=%B
見出しの色を決める\n\n水色にした。

--format=%B は、件名と本文をそのまま表示する書式です。\n が改行になるかどうかは、git ではなく、シェルでの書き方で決まります。ここでは、このコミットを git reset --soft HEAD~1 で取り消し、下の書き方でやり直しました。

引用符を閉じる前に Enter を押して改行する

bash では、二重引用符(")を閉じる前に Enter を押すと、コマンドが実行されずに次の行の入力に移ります。続きの行の先頭には > が表示されます。件名を書いて Enter、空の行で Enter、本文を書いて " で閉じると、その改行がそのままメッセージに入りました。

console
$ git commit -q -m "見出しの色を決める
> 
> 見出しを濃い水色にした。"
$ git log -1 --format=%B
見出しの色を決める

見出しを濃い水色にした。

> はシェルが表示しているもので、メッセージには入りません。

$'…' の中なら \n が改行になる

bash では、$'...' の形で囲むと、中の \n が改行になります。1行で書けるので、スクリプトの中でも使いやすい書き方です。

console
$ git commit -q -m $'日記を1件書く\n\n晴れの日の記録を足した。'

$ git log -1 --format=%B
日記を1件書く

晴れの日の記録を足した。

-F でファイルや標準入力から読む

長いメッセージや箇条書きは、ファイルに書いておいて -F で読ませる方法があります。

console
$ cat ../msg.txt
日記をもう1件書く

- 雨の日の記録を足した
- 段落は p 要素で分けた

$ git commit -q -F ../msg.txt

$ git log -1 --format=%B
日記をもう1件書く

- 雨の日の記録を足した
- 段落は p 要素で分けた

公式リファレンスの -F の説明にあるとおり、ファイル名の代わりに - を渡すと、標準入力から読みます。bash のヒアドキュメントと組み合わせると、ファイルを作らずに書けます。MSG は区切りの言葉で、MSG だけの行の手前までがメッセージになります。

console
$ git commit -q -F - <<'MSG'
フッターの文字を小さくする

12px にした。
MSG

$ git log -1 --format=%B
フッターの文字を小さくする

12px にした。

-m を付けずに、エディターで書く

-m も -F も付けずに git commit を実行すると、エディターが開きます。使うエディターは、環境変数 GIT_EDITOR、設定の core.editor、環境変数 VISUAL、EDITOR の順に決まると、公式リファレンスの環境変数と設定の節に書かれています。

検証では GIT_EDITOR に、渡されたファイルの中身を表示してから、先頭に次の4行と空行1行を書き足すだけのスクリプト(../editor.sh)を指定しました。1行目はわざと # で始めています。

text
# メモ:この行は消える
タイトルを付ける

title 要素を足した。

エディターには、# で始まる説明の行が入ったファイルが渡されていました。

console
$ GIT_EDITOR=../editor.sh git commit -q
----- エディターに渡されたファイル -----

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch main
# Changes to be committed:
#	modified:   index.html
#
----- ここまで -----

$ git log -1 --format=%B
タイトルを付ける

title 要素を足した。

ふだんのエディターでは、このファイルの1行目に件名を書き、空の行を1つ挟んで本文を書いてから、保存して閉じます。説明の行と、書き足した # メモ の行は、どちらもメッセージから消えています。

-m で書くと、# で始まる行は消えない

エディターでは消えた # の行ですが、-m で渡したときは残りました。

console
$ git commit -q -m "日記を1件書く" -m "#3 のくもりの日の分。"

$ git log -1 --format=%B
日記を1件書く

#3 のくもりの日の分。

公式リファレンスの --cleanup の説明によると、何も指定しないときは、メッセージをエディターで編集する場合は # の行を消し(strip)、そうでない場合は前後の空行や行末の空白だけを整えます(whitespace)。

件名の後に空行がないと、2行目まで件名になる

件名と本文の間に空行を入れずに、2行のメッセージを作りました。

console
$ git commit -q -m $'リンクの色を決める\nピンクにした。'

$ git log --oneline -1
f786f05 リンクの色を決める ピンクにした。

$ git log -1 --format=%s
リンクの色を決める ピンクにした。

$ git log -1 --format=%b

git log --oneline にも件名の %s にも、2行目が空白でつながって出ています。本文の %b は空でした。公式リファレンスの説明では、最初の空行までが件名(タイトル)として扱われ、Git のあちこちで使われるとされています。同じ節では、件名は50文字以内の短い1行にし、空行を挟んで詳しい説明を書くことが勧められています。

操作の後の履歴

ここまでのコミットを git log --oneline で見ると、件名だけが1行ずつ並びます。空行を挟んで書いたコミットでは、本文は表示されず、件名だけが出ています。空行を入れなかった最後のコミットだけ、2行目まで出ています。

console
$ git log --oneline
f786f05 リンクの色を決める ピンクにした。
c7b3429 日記を1件書く
cfa57c8 タイトルを付ける
7f9274d フッターの文字を小さくする
0adcc78 日記をもう1件書く
afb61a0 日記を1件書く
eed4696 見出しの色を決める
6a7e8c5 文字の色を決める
7e817a6 トップページを作る

​Posted by 86