目標

• Gitの初期設定を行う
• コマンドラインでのGitの操作を一通り確認する
• VS CodeからもGitを操作できることを確認する

課題: Gitの基本操作

Step 1: 初期設定

ターミナルを開き、以下を実行せよ。

git config --global user.name "ユーザー名"
git config --global user.email "メールアドレス"

この名前とメールアドレスは後に公開されるため、イニシャルやニックネームなどでも良い。また、ここで「タブ補完」が効くことも確認しておこう。

• git conまで入力してタブを押すとgit configまで入力される
• --glまで入力してタブを押すと--globalまで入力される
• usまで入力してタブを押すとuser.まで入力される
• nまで入力してタブを押すと、nameまで入力される

以上から「git con(TAB)–gl(TAB)us(TAB)n(TAB)」と入力するとgit config --global user.nameまで入力が完了する。これをタブ補完と呼ぶ。慣れると便利なので、普段から意識して使うようにすると良い。

また、デフォルトエディタをVimにする設定、改行コードの設定、デフォルトブランチ名の設定をしておこう。

git config --global core.editor vim
git config --global core.autocrlf false
git config --global init.defaultBranch main

次に、よく使うコマンドの省略系(エイリアス)も登録しておこう。いろいろ便利なエイリアスがあるが、人や部署によって流儀が異なるので、今回は以下の一つだけを設定しよう。

git config --global alias.st "status -s"

以上を実行後、ターミナルで.gitconfigを表示し、先ほど設定した内容が書き込まれていることを確認せよ。

cat .gitconfig

以下のような表示になっていれば成功である。なお、環境や操作により順序が入れ替わっている場合があるが、同じ内容が記述されていれば問題ない。

[user]
        name = 先ほど設定したユーザー名
        email = 先ほど設定したメールアドレス
[core]
        editor = vim
        autocrlf = false
[alias]
        st = status -s
[init]
        defaultBranch = main        

Step 2: リポジトリの作成(git init)

それではいよいよGitの操作を一通り確認する。

まずは適当なテスト用のディレクトリを作成し、その中で作業しよう。この講義用にgithubというディレクトリを作成し、さらにその中にtestというディレクトリを作ろう。

cd
mkdir github
cd github
mkdir test
cd test

最初にcdを入力しているのは、ホームディレクトリに戻るためだ。これでgithubディレクトリの下のtestディレクトリがカレントディレクトリとなった。

このtestディレクトリの中にREADME.mdというファイルを作成しよう。そして、このディレクトリをVS Codeで開こう。VS Codeが起動したら「ファイル」メニューから「フォルダーを開く(もしくは Open Folder…)」を選び、先ほど作成したディレクトリを選ぼう。もしくは、カレントディレクトリが~/github/testである状態で、ターミナルから

code .

を実行すると、カレントディレクトリを対象に「フォルダを開いた」状態でVS Codeが起動する。

フォルダーを開いたら、左のエクスプローラーの「TEST」の右にある「新しいファイル」ボタンを押して、README.mdと入力せよ。READMEまで大文字、mdが小文字である。

README.mdファイルが開かれたら、

# Test

とだけ入力し、保存しよう。改行を入れるのを忘れないこと。この際、右下に「CRLF」と表示されている場合は、そこをクリックして「改行コードを選択」画面を出し、「LF」を選ぶこと。

これで、以下のようなディレクトリ構成になったはずだ。

github
└── test
    └── README.md

この状態でターミナルに戻り、リポジトリとして初期化しよう。

git init

すると、.gitというディレクトリが作成され、testディレクトリがリポジトリとして初期化される。以下を実行せよ。

ls -la

README.mdに加え、.gitというディレクトリが作成されたことがわかるはずだ。

git initした直後は、「現在のディレクトリtestをGitで管理することは決まったが、まだGitはどのファイルも管理していない」、すなわち歴史が全く無い状態になる。

この状態を確認してみよう。以下を実行せよ。

git status

以下のような表示が得られるはずだ。

On branch main

No commits yet

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        README.md

nothing added to commit but untracked files present (use "git add" to track)

ここには、

• まだ何もコミットがなく(No commits yet)
• README.mdという管理されていないファイルがあるので(Untracked files)
• もし管理したければgit addしてね(use “git add” to track)

と書いてある。

状態を見るのにいちいちこんな長いメッセージを見せられても困るので、-sオプションをつけて見よう。

git status -s

こんな表示がされたはずだ。

?? README.md

??と、?が二つ表示された。git status -sは、ファイルの状態を二つの文字であらわす。それぞれ右がワーキングツリー、左がインデックスの状態を表している。今回のケースはどちらも?なので、ワーキングツリーにもインデックスにも無い、すなわちGitの管理下に無い(Untracked)という意味だ。

さて、いちいちgit status -sと入力するのは面倒なので、最初にgit status -sにgit stという別名をつけておいた。以下を実行せよ。

git st

正しくエイリアスが設定されていれば、git status -sと入力したのと同じことになる。以後こちらを使うことにしよう。

Step 3: インデックスへの追加(git add)

さて、Untrackedな状態のファイルをGitの管理下に置こう。そのためにgit addを実行する。

git add README.md

現在の状態を見てみよう。

git st

こんな表示になるはずだ。

A  README.md

これは「README.mdが追加されることが予約されたよ」という意味で、インデックスにREADME.mdが追加された状態になっている。

は、記念すべき最初のコミットをしよう。Gitはコミットをする時に、コミットメッセージが必要となる。最初のメッセージは慣例によりinitial commitとすることが多い。

git commit -m "initial commit"

これによりコミットが作成され、README.mdはGitの管理下に入った。

状態を見てみよう。

git st

何も表示されないはずである。ロングバージョンのステータスも見てみよう。

$ git status
On branch main
nothing to commit, working tree clean

自分がいまmainブランチにいて、何もコミットをする必要がなく、ワーキングツリーがきれい(clean)、つまりリポジトリが記憶している最新のコミットと一致していることを意味している。

Step 4: ファイルの修正

次に、ファイルを修正してみよう。VS Codeで開いているREADME.mdに、行を付け加えて保存しよう。

# Test

Hello Git!

「Hello Git!」の最後の改行を忘れないように。状態を見てみよう。

$ git st
 M README.md

ファイル名の前にMという文字がついた。これはModifiedの頭文字であり、かつ右側に表示されていることから「ワーキングツリーとインデックスに差があるよ」という意味だ。

また、この状態でgit diffを実行してみよう。

$ git diff
diff --git a/README.md b/README.md
index 8ae0569..6f768d9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,3 @@
 # Test
+
+Hello Git!

行頭に+がついた箇所が追加された行である。

この修正をリポジトリに登録するためにステージングしよう。

git add README.md

また状態を見てみよう。

$ git st
M  README.md

先ほどは赤字で二桁目にMが表示されていたのが、今回は緑字で一桁目にMが表示されているはずである。これは、インデックスとワーキングツリーは一致しており(二桁目に表示がない)、インデックスとリポジトリに差がある(一桁目にMが表示される)ということを意味している。

この状態でコミットしよう。

git commit -m "adds new line"

修正がリポジトリに登録され、ワーキングツリーがきれい(clean)な状態となった。

Step 5: 自動ステージング(git commit -a)

Gitでは原則として

• ファイルを修正する
• git addでコミットするファイルをインデックスに登録する(ステージングする)
• git commitでリポジトリに反映する

という作業を繰り返す。実際、多人数で開発する場合はこうして「きれいな歴史」を作る方が良いのだが、一人で開発している場合はgit addによるステージングを省略しても良い。

git addを省略するには、コミットする時にgit commit -aと、-aオプションをつける。すると、Git管理下にあり、かつ修正されたファイル全てを、ステージングを飛ばしてコミットする。その動作を確認しよう。

まず、VS Codeでさらにファイルを修正しよう。README.mdに以下の行を付け加えよう。やはり最後の改行を忘れないように。

# Test

Hello Git!
Bye Git!

この状態で、git addせずにgit commitしようとすると、「何をコミットするか指定が無いよ(インデックスに何も無いよ)」と怒られる。

$ git commit -m "modifies README.md"
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   README.md

no changes added to commit (use "git add" and/or "git commit -a")

上記メッセージには、まずgit addするか、git commit -aしろとあるので、ここでは後者を実行しよう。オプションは-mとまとめて-amとする。

git commit -am "modifies README.md"

以後、慣れた場合はgit commit -amを使うことでステージングを省略しても良い。

Step 6: 歴史の確認(git log)

これまでの歴史を確認して見よう。上記の通りに作業して来たなら、3つのコミットが作成されたはずだ。git logで歴史を振り返ってみよう。

$ git log
commit be7533fe7e4f565342bc86c1e8f0f2a9f3c284ae (HEAD -> main)
Author: H. Watanabe <kaityo256@example.com>
Date:   Mon Aug 23 23:32:48 2021 +0900

    modifies README.md

commit dd14099193d5ca080e37674ae474f558457d0cb7
Author: H. Watanabe <kaityo256@example.com>
Date:   Mon Aug 23 23:31:01 2021 +0900

    adds new line

commit 02b8501966eb17df1e2d79c7a33e61feadd678cf
Author: H. Watanabe <kaityo256@example.com>
Date:   Mon Aug 23 23:29:45 2021 +0900

    initial commit

いつ、誰が、どのコミットを作ったかが表示される。それぞれのコミットハッシュは異なるものになっているはずだ。

デフォルトの表示では見づらいので、一つのコミットを一行で表示しても良い。

$ git log --oneline
be7533f (HEAD -> main) modifies README.md
dd14099 adds new line
02b8501 initial commit

個人的にはこちらの方が見やすいので、l(←小文字のLであり、数字の1ではないことに注意)をlog --onelineのエイリアスにしてしまっても良いと思う。もしそうしたい場合は、

git config --global alias.l "log --oneline"

を実行せよ。以後、

git l

で、コンパクトなログを見ることができる。

Step 7: VS Codeからの操作

Gitは、VS Codeからも操作することができる。今、README.mdを開いているVS Codeで何か修正して、保存してみよう。例えば以下のように行を追加する。

# Test

Hello git
Bye git
Git from VS Code

修正を保存した状態で左を見ると、「ソース管理」アイコンに「1」という数字が表示されているはずだ。これは「Gitで管理されているファイルのうち、一つのファイルが修正されているよ」という意味だ。

この「ソース管理アイコン」をクリックしよう。

すると、ソース管理ウィンドウが開き、「変更」の下に「README.md」がある。うまく表示されない場合はエクスプローラーから「エクスプローラーを最新表示する(Refresh)」をクリックし、最新表示としよう。

そのファイル名の右にある「+」マークをクリックしよう。README.mdが「変更」から「ステージング済みの変更」に移動したはずだ。

これはターミナルで

git add README.md

を実行したことに対応する。

この状態で「メッセージ」のところにコミットメッセージを書いて、上の「チェックマーク」をクリックすると、コミットできる。例えばメッセージとして「commit from VS Code」と書いてコミットしてみよう。

これでコミットができた。これは、ターミナルで

git commit -m "commit from VS Code"

を実行したことに対応する。ちゃんとコミットされたかどうか、ターミナルから確認してみよう。

$ git log --oneline
0c18b48 (HEAD -> main) commit from VS Code
be7533f modifies README.md
dd14099 adds new line
02b8501 initial commit

VS Codeから作ったコミットが反映されていることがわかる。

基本的にVS CodeからGitの全ての操作を行うことができるが、当面の間はコマンドラインから実行した方が良い。慣れてきたらVS Codeその他のGUIツールを使うと良いだろう。