[git] リモートURLを変更する(remote set-url)

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[git] リモートURLを変更する(remote set-url)

ウケるくらい忘れるからメモ。

リポジトリを別の Organization に移したとき、リポジトリ名を変えたとき、HTTPS から SSH に切り替えたいとき——年に数回しかやらないので、毎回「なんだっけ」になります。

基本形

git remote set-url origin <新しいURL>

origin はリモート名。ほとんどの場合 origin のままでOKです。

まず今の設定を確認する

git remote -v
# origin  https://github.com/old-owner/repo.git (fetch)
# origin  https://github.com/old-owner/repo.git (push)

変更後にもう一度 git remote -v を打って、URLが変わっていれば完了。変更前後に1回ずつ確認するのが癖にしておくと安心です。

よくあるパターン

HTTPS → SSH に切り替える

毎回パスワード(トークン)を聞かれるのが面倒になったら SSH へ。

git remote set-url origin git@github.com:owner/repo.git

逆に SSH → HTTPS はこう。

git remote set-url origin https://github.com/owner/repo.git

リポジトリ名の変更・Organization への移管のあと

GitHub はリネームや移管のあとも旧URLからリダイレクトしてくれるので、しばらくはそのままでも push できてしまいます。ただ、旧URLに同名のリポジトリが新しく作られるとリダイレクトは切れるので、気づいたタイミングで付け替えておくのが無難です。

git remote set-url origin git@github.com:new-owner/new-repo.git

関連コマンド

やりたいことコマンド
一覧を見るgit remote -v
URLを変えるgit remote set-url origin <URL>
リモートを追加するgit remote add upstream <URL>
リモート名を変えるgit remote rename origin old-origin
リモートを削除するgit remote remove upstream

フォークしたリポジトリで本家を追いかけるときの upstream 追加も、このあたりと一緒に覚えておくと便利です。

ハマりどころ・メモ

  • リモート名の打ち間違い: git remote set-url orign ... のように存在しない名前を指定すると No such remote で怒られます。まず git remote -v で名前を確認
  • SSHに切り替えたのに認証エラー: URLではなく鍵の問題のことが多いです。ssh -T git@github.com で接続できるか先に確かめる
  • 設定の実体は .git/config の [remote "origin"] セクション。直接開いて書き換えても同じことになります

まとめ

  • リモートURLの変更は git remote set-url origin <新しいURL>
  • 前後に git remote -v で確認
  • リネーム・移管後はリダイレクトに頼らず、早めに付け替える

次に忘れたときも、たぶんこのページを開きます。

git