GitHubアカウントは作成済みで、レポジトリもあることを想定
※ 本記事ではMacbook上の説明をしていますが、基本的にWindows WSL2でも使えます
GitHubのSSH認証を設定
zsh
ls -al ~/.ssh # 既存のSSHキーがあるか確認します
何も表示されなければSSHキーが存在しないので、以下のコードで新規作成しましょう
zsh
ssh-keygen -t ed25519 -C "GitHubに登録したメールアドレス"
- 保存先の指定: そのままEnterを押すと ~/.ssh/id_ed25519 に保存されます
- パスフレーズ: オプションですが、セキュリティを強化したい場合は設定しておきましょう
SSHエージェントを起動
SSHキーを現在のセッションで使用可能とします
zsh
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519
SSHキー(id_ed25519.pub)の内容をコピーしておきます
zsh
pbcopy < ~/.ssh/id_ed25519.pub
- GitHubのSSHキー設定ページを開く(settings > SSH and GPG keys)
- 新しいSSHキーを追加
• 「New SSH key」をクリック。
• タイトルを任意で入力(例: “MacBook SSH Key”)。
• コピーした公開鍵を「Key」フィールドにペースト。 - 「Add SSH key」をクリックして保存。
GitHubにSSHでアクセスできるか確認
zsh
ssh -T git@github.com
初回は「Are you sure you want to continue connecting?」にyesと入力。
成功すると、以下のメッセージが表示される
zsh
git remote set-url origin git@github.com:<GitHubユーザー名>/<レポジトリ名>.git
すべて完了したら、GitHubリポジトリからデータを取得してみてください。
初回:clone
更新:pull
zsh
# リモートリポジトリをローカルにクローン
git clone git@github.com:<GitHubユーザー名>/<レポジトリ名>.git <レポジトリ保存先へのパス>
-
リポジトリのCloneとは?
ローカルに新しいフォルダが作成され、リモートリポジトリの内容がコピーされる
保存先を指定しておくとよい(例えば~/GitHub_repos/<レポジトリ名>)
zsh
# 現在のブランチをリモートリポジトリの最新状態に更新
git pull origin main
-
リポジトリのPullとは?
ローカルに既にClone済みのリポジトリを更新する
最後に
基本的なのに知らなかった内容
- SSH形式:git@github.com:/<レポジトリ名>.git
- HTTP形式:https://github.com//<レポジトリ名>.git
この時点で知っておくべきTipsや基本的内容があればぜひコメントください!