SSHを使用してGitリポジトリをローカル環境へクローンしたい

はじめに

Git リポジトリをローカル環境へクローンするために参照するGitHub の公式ドキュメントが複数あるため、備忘録として記事にアウトプットします

参照 : SSH を使用したGitHub への接続

既存のSSH キーの確認

1. [ターミナル]を開く

2. 以下を実行して、既存のSSHキーが存在するか確認する（ディレクトリはどこでもOK）

   ターミナル

   ls -al ~/.ssh
   

3. ディレクトリの一覧から、公開SSHキーをすでに持っているか確認する。既定では、GitHubでサポートされている公開鍵のファイル名は次のいずれか

   • id_rsa.pub
   • id_ecdsa.pub
   • id_ed25519.pub

4. 確認が

   1. できなければ「新しいSSHキーを生成してssh-agentに追加する」へ

   2. できたら「SSH接続をテストする」へ

参照 : 既存のSSH キーの確認

新しいSSH キーを生成してssh-agent に追加する

新しいSSH キーを生成する

1. [ターミナル]を開く

2. 以下を実行する（"[e-mail]"を自分のGitHub アカウントのメールアドレスに置き換える）

   ターミナル

   ssh-keygen -t ed25519 -C "[e-mail]"
   

3. 指定したメールアドレスをラベルとした「id_ed25519」という名前の新しいSSH キーが作成される

SSH キーをssh-agent に追加する

1. 以下を実行して、バックグラウンドでssh-agent を開始する

   ターミナル

   eval "$(ssh-agent -s)"
   

2. 以下を実行してconfig ファイルが規定の場所に存在するかどうかを調べる

   ターミナル

   open ~/.ssh/config
   

   1. ファイルがない場合は、touch ~/.ssh/configを実行してファイルを作成する

3. config ファイルの中身を以下の内容に変更する

   configファイル

   Host github.com
     AddKeysToAgent yes
     UseKeychain yes
     IdentityFile ~/.ssh/id_ed25519
   

4. 以下を実行して、SSH 秘密鍵をssh-agent に追加して、パスフレーズをキーチェーンに保存する

   ターミナル

   ssh-add --apple-use-keychain ~/.ssh/id_ed25519
   

5. GitHub で自分のアカウントにSSH 公開キーを追加する
   「GitHub アカウントへの新しいSSH キーの追加」を参照

参照 : 新しいSSH キーを生成してssh-agent に追加する

GitHub アカウントへの新しいSSH キーの追加

1. [ターミナル]を開く

2. 以下を実行してSSH 公開キーをクリップボードにコピー

   ターミナル

   pbcopy < ~/.ssh/id_ed25519.pub
   

3. GitHub で右上隅にある自分のプロフィールをクリックしてから、[Setting]をクリック
   

4. 左側のサイドバーの[Access]にある[SSH and GPG keys]をクリック
   

5. [New SSH key]をクリック
   

6. [Title], [Key type]は任意

7. [Key]に先ほどコピーした公開キーをペースト

8. [Add SSH key]をクリック
   

SSH 接続をテストする

1. [ターミナル]を開く

2. 以下を実行する

   ターミナル

   ssh -T [e-mail]
   

3. 以下のメッセージが表示されたらOK

   Hi USERNAME! You've successfully authenticated, but GitHub does not provide shell access.
   

4. 以下のメッセージが出ても、接続できている（っぽい）(その後の挙動に問題なし)

   [e-mail]: Permission denied (publickey).
   

リポジトリをローカルにクローンする

1. GitHub上のクローンしたいリポジトリのページの[Code]から[SSH]のリンクをコピー

2. 以下を実行する(your_repository_codeにコピーしたリンクをペースト)

   ターミナル

   git clone your_repository_code
   

3. lsでクローンしたリポジトリのフォルダがあることを確認