こんにちは、おくやんです。
このブログでは、開発に役立つノウハウを実践的なコード例と共に紹介しています。
今回は、このようなお悩みを解決します。
本記事の内容
今回はWSL上でGitを利用するための環境構築手順についてまとめました。
開発を行う上でGitを利用する機会は多いです。WSLを利用することでWindowでもLinuxと同じようにGitを使うことができるようになります。
本記事を参考にセットアップを行ってみてください。
WSL上にGit環境を構築
WSL上でGitを利用できるようにしていきましょう。Git環境の構築手順はこちらになります。
Git環境構築手順
2. ユーザの設定登録
3. git statusの文字化け対応
4. その他やっておくと便利な設定
手順1～3については対応が必須となります。手順4に関しては好みで実施してみてください。
1. Gitのインストール
まずはGitのインストールを行います。すでにインストールされている場合もあるので確かめてみましょう。
下記コマンドを実行してみてください。
git --versiongitのバージョンが正しく表示されば、すでにインストールされています。エラーとなった人はインストールコマンドを実行しましょう。
sudo apt install gitインストール完了後、バージョンが正しく表示されたらOKです。
続いてユーザ情報を登録していきます。
2. ユーザの設定登録
Gitにユーザの情報を登録していきます。登録する内容はメールアドレスとユーザ名になります。
まずはメールアドレスから登録します。下記コマンドを実行してください。
git config --global user.email [メールアドレス]「[メールアドレス]」の部分には自分のアドレスを登録してください。
続いてユーザ名を登録します。
git config --global user.name [ユーザ名]「[ユーザ名]」はログ表示などで利用されます。複数人で作業する予定がある場合は、誰か判別できるユーザ名にしておきましょう。
3. git statusの文字化け対応
デフォルトの設定では、git statusコマンドを実行した際に日本語が文字化けしてしまいます。
正しく表示できるように設定を追加しましょう。
git config --local core.quotepath false設定を追加後、git statusコマンドを実行すると日本語を含むファイルでも正しく表示されます。
最後にやっておくと便利な設定も紹介します。
4. その他やっておくと便利な設定
下記設定を行っておくと、開発を行っていく上で役に立ちます。必要に応じて実施しておきましょう。
やっておくと便利な設定
② エディター設定
③ コミットメッセージ設定
① 文字色の設定
git diffコマンドやgit statusコマンドを実行した際に、わかりやすく文字の色を変更してくれる設定です。下記コマンドで設定ができます。
git config --global color.ui true差分や変更部分を色分けして強調してくれるため、ターミナル上の文字が見やすくなります。
設定がある場合とない場合の比較です。
色分けされることで、差分も確認しやすくなります。
② エディター設定
コミットメッセージを入力する際のエディターを設定します。初期設定だとnanoが設定されているため、お好みのエディターに設定を変更しておきましょう。
viを設定する場合は下記コマンドで変更できます。
git config --global core.editor vimコミットするたびに利用するので、使い慣れているエディターを設定しておくと便利です。
③ コミットメッセージ設定
コミットする際のテンプレートフォーマットを指定します。
複数人で開発を行う際は各自設定しておくと、コミットメッセージの書き方を統一化できるので便利です。設定は下記コマンドで行います。
git config --global commit.template [テンプレートフォーマットファイルパス]必要に応じて登録を行っておきましょう。
Gitリポジトリへのssh設定手順
続いてはGitHubやGitLabなどのGitホスティングサービス上にあるリポジトリへ、ssh接続するための設定を行っていきます。
設定の手順は下記となります。
ssh設定手順
2. ホスティングサービス上に公開鍵を登録
自PC上で公開鍵・秘密鍵を作成し、作成した公開鍵をサービス上に登録する流れです。
公開鍵の登録方法は利用しているサービスによって異なるため、今回はGitHubとGitLabに登録する手順を紹介していきます。
1. 公開鍵・秘密鍵の作成
それでは早速、公開鍵・秘密鍵の作成を行っていきます。
下記コマンドを実行してください。
ssh-keygen -t rsa -b 4096 -C [メールアドレス]「[メールアドレス]」の部分にはGit環境構築時に設定したメールアドレスを設定します。
コマンド入力後は鍵の保存場所やパスフレーズの入力を求められますが、未設定のままで大丈夫です。
鍵が作成されたか確認してみましょう。下記コマンドを実行してください。
ls -la ~/.ssh「id_rsa」と「id_rsa.pub」が作成されていればOKです。「id_rsa」が秘密鍵、「id_rsa.pub」が公開鍵となります。
これで鍵の作成は完了です。次は秘密鍵を各サービスに登録していきましょう。
まずはGitHubの登録方法を紹介します。
2-①. GitHub上に公開鍵を登録
公開鍵をGitHubの設定画面で登録していきます。
まずはGitHubにログインしましょう。アカウントがない場合は新規作成してからログインしてください。
ログイン後、公開鍵の登録画面を開きます。下記の手順で移動できます。
公開鍵登録画面の開き方
② 表示されたメニューから「Settings」をクリック
③ 画面左のメニューから「SSH and GPG keys」をクリック
④ 画面右上の「New SSH key」をクリック
公開鍵登録画面から、作成した公開鍵を登録します。「id_rsa.pub」の内容をそのまま張り付けましょう。
「Add SSH key」をクリックして登録完了です。
リポジトリをクローンしてみましょう。GitHubのリポジトリページから接続文字列を取得します。
git cloneコマンドを実行します。引数に先ほど取得した接続文字列を設定して、手実行ましょう。
無事ダウンロードできたらOKです。
次はGitLabの登録方法を紹介します。
2-②. GitLab上に公開鍵を登録
GitLabに公開鍵を登録していきます。
GitLabにログインしましょう。アカウントがない場合は新規作成してからログインしてください。
ログイン後、公開鍵の登録画面を開きます。下記の手順で移動できます。
公開鍵登録画面の開き方
② 表示されたメニューから「Edit profile」をクリック
③ 画面左のメニューから「SSH Keys」をクリック
公開鍵登録画面から、作成した公開鍵を登録します。「id_rsa.pub」の内容をそのまま張り付けましょう。
「Add key」をクリックして登録完了です。
リポジトリをクローンしてみましょう。GitLabのリポジトリページから接続文字列を取得します。
git cloneコマンドを実行します。引数に先ほど取得した接続文字列を設定して、実行ましょう。
無事ダウンロードできたらOKです。
これでssh設定は完了です。
まとめ:WSL上にGit環境を構築しよう
本記事ではWSL上でのGit環境手順について解説しました。
環境構築は下記4つの手順となります。
Git環境構築手順
また、GitHubなどの外部サービスにssh接続する手順は下記となります。
ssh設定手順
WSLでGit環境を整えることで、WIndowsでもLinux同様にGitが利用できるようになります。
本記事を参考に早速環境の構築をしてみましょう。
最後まで読んでいただき、ありがとうございます。