Gitを使い始めるときに行う設定（git config）

Gitをインストールした後など、使い始めるときに行う2つの設定について解説します。

ユーザー名を設定する

使い始める前に行う設定の１つ目はユーザー名の設定です。

git config --global user.name "Taro Yamada"

user.nameはユーザー名を表します。一般的には本名をローマ字で書くのが一般的ですが、ハンドル名やニックネーム等を使用しても構いません。

仕事で使う場合は、組織やプロジェクトでのルールに従ってください。

氏名をユーザー名に設定する場合、姓と名の間に半角スペースを含むため、ユーザー名全体を「”」（ダブルクォーテーション）で囲みます。スペースを含まない場合は「”」（ダブルクォーテーション）で囲む必要はありません。

メールアドレスを設定する

使い始める前に行う設定のもう一つは、メールアドレスの設定です。

git config --global user.email taro.yamada@example.com

user.emailはメールアドレスを表します。

使用可能なメールを使用することが強く推奨されるため、個人開発の場合は個人のメールアドレス、仕事での開発の場合は組織で使用されているメールアドレスを使用してください。

メールアドレスにはスペースを含むことがないので「”」（ダブルクォーテーション）は必要ありません。

設定を確認する

現在の設定を確認するには、-lオプションを使います。

前述の設定を行ったあとに、設定を確認すると以下のような結果になります。

$ git config --global -l

user.name=Taro Yamada
user.email=taro.yamada@example.com

ユーザー名とメールアドレスは何に使うの？

設定したユーザー名とメールアドレスはどこに使われるのでしょうか？

設定したユーザー名とメールアドレスは、コミットログのAuthorに使用されます。
前述の設定を行ったうえでファイルをコミットして、ログでコミットログを確認すると以下のようになります。

$ git log       
commit daa1b044d5794411dd25e9f404a4f96a0b4d1006 (HEAD -> main)
Author: Taro Yamada 
Date:   Sat Mar 12 20:45:39 2022 +0900

    add test.txt

Author欄に先ほど設定したユーザー名とメールアドレスが設定されていることが分かります。

プロジェクト固有の設定を行いたい場合は？

すでに説明した設定はグローバル設定（--global）となっています。

例えば、

在宅勤務で自宅のPCをしており、普段は個人で開発していますが、仕事でも使うことになりました。
個人で開発する際のユーザー名とメールアドレスはグローバル設定として登録済みです。仕事では会社のメールアドレスを使う必要があります。

この場合、ローカル設定を使うことで解決できます。

まずは現在のグローバル設定を確認します。

$ git config --global -l

user.name=Taro Yamada
user.email=taro.yamada@example.com

次に仕事で使うプロジェクト（ここでは「user_service」）に移動して、再度設定を確認します。

$ cd user_service
$ git config --global -l

user.name=Taro Yamada
user.email=taro.yamada@example.com

当然ですが、設定は変わりません。
ここではローカル設定（--local）を行います。

まずは設定を行います。

$ git config --local user.name t-yamada
$ git config --local user.email t-yamada@kaisha.com

先ほどとの違いは、--globalが--localになっただけです。

では、設定を確認してみましょう。設定の確認も同様に--localオプションを使用します。

$ git config --local -l
core.repositoryformatversion=0
core.filemode=false
core.bare=false
core.logallrefupdates=true
core.symlinks=false
core.ignorecase=true
user.name=t-yamada
user.email=t-yamada@kaisha.com

少し余計な設定が出力されていますが、一番下にuser.nameとuser.emailが出力されており、設定値は--localオプションを使用して設定したものになっています。

では適当なファイルをコミットして、コミットログを確認してみます。

$ touch test.txt
$ git add test.txt
$ git commit -m 'add test.txt'
[main (root-commit) 11eecab] add test.txt
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 test.txt
$ git log 
commit 11eecab9335ca6e43e4efc6c2a43f37fb7be41b3 (HEAD -> main)
Author: t-yamada 
Date:   Sat Mar 12 21:55:04 2022 +0900

    add test.txt

ファイルの追加やコミットのオプションは特に変えていませんが、確かに--localで設定したユーザー名、メールアドレスで記録されています。

このように複数の環境を使い分ける場合はローカル設定を活用してください。