gitで登録済みリモートリポジトリのURLを修正する場面は、リポジトリの移行や設定ミスなど、開発の現場で頻繁に発生します。
接続先URLの変更でよく使われるのが「git remoteコマンド」で、コマンドが内部的にローカルの.git/configを書き換える仕組みです。特別な権限は必要ありませんが、push/fetch実行時はリモート側への認証が別途必要です。
この記事では、gitのremote設定を変更する基本的な使い方を解説していきます。URLの修正方法や通信方式を切り替える手順、名前の変更方法など、サンプルコード付きで解説していきますので、ぜひ参考にしてください。
git remoteの設定を変更する方法
リモート設定の変更は、コマンドラインから現在の状態を確認した上で、目的に応じたサブコマンドを実行するのが基本的な流れです。
現在の設定を確認する
変更作業を始める前には、現在登録されているリモートリポジトリの名前とURLを正しく把握しておく必要があります。
設定内容の一覧を表示する使い方は、以下の通りです。
git remote -v
上記のコードでは、-v(--verbose)オプションを付与することによって、登録済みの全リモート名と、それぞれのfetch用・push用URLを一覧表示しています。fetch/pushそれぞれのURLを表示するため2行ですが、push専用URLを別途設定した場合(git remote set-url --push)は異なる値が表示されます。
変更前後でgit remote -vを実行する習慣を付けておくと、URLの打ち間違いやリモート名の指定ミスに早い段階で気付ける点がメリットです。
別のURLに変更する
リポジトリの移行やURLの登録ミスがあった場合は、set-urlサブコマンドを使って既存の接続先を上書きできます。リモート名を指定した上で新しいURLを引数に渡すだけで、設定ファイルの該当行が直接書き換わる仕組みです。
GitHub公式ドキュメントでは、このコマンドについて、次のように説明しています。
git remote set-url コマンドは、既存のリモート リポジトリ URL を変更します。
出典:GitHub公式ドキュメント「リモートリポジトリを管理する」
既存のリモート名であるoriginに対して新しいURLを設定するコードは、以下の通りです。
git remote set-url origin https://github.com/user/new-repo.git
上記のコードでは、対象のリモート名と新しいURLを指定し、既存の設定を直接書き換える処理を実行しています。GitHubなどのサービスを利用する際は、URLの打ち間違いに注意しながら作業を進めるのがポイントです。
HTTPSからSSHに切り替える
HTTPS接続からSSH接続へと通信方式を切り替えると、認証情報ヘルパーを使用しない場合でもPersonal Access Tokenの都度入力が不要です。ただし、SSH接続には事前の設定が必要なため、以下の2点が完了していることを確認してください。
- GitHubアカウントへのSSH公開鍵の登録
- パスフレーズを設定した秘密鍵を使用する場合は、ローカルマシンのssh-agentへの秘密鍵の登録(
ssh-addコマンドを使用)
上記の前提が整っている状態で、GitHubのURLをSSH形式に変更する場合のコードは、以下の通りです。
git remote set-url origin git@github.com:user/repo.git
上記のコードでは、https://から始まるURLの代わりに、git@から始まるSSH用の文字列を指定しています。SSH公開鍵の登録方法については、GitHubの公式ドキュメントを参照してください。
リモートの名前を変更する
デフォルトのoriginという名前を別の名称に変えたいときは、renameサブコマンドを利用します。フォーク元と自分のリポジトリを区別する場合など、複数のリモートを管理する際に役立つコマンドです。
現在の名前を新しい名前に変更するコードは、以下の通りです。
git remote rename origin upstream
上記のコードでは、第一引数に現在の名前を指定し、第二引数に変更後の新しい名前を渡して設定を更新しています。rename実行後は、例えばrefs/remotes/origin/*がrefs/remotes/upstream/*へと自動的に更新され、.git/configの関連設定も合わせて変更されるため、既存のブランチ追跡設定は通常そのまま引き継がれます。
複数のリモートリポジトリを登録している環境では、それぞれの役割が明確に伝わる名前を選ぶと管理しやすくなります。
git remoteの変更に関するよくある質問
間違ったリモートURLを登録してしまった場合は?
間違ったURLを登録した場合は、git remote set-urlコマンドで正しいURLへ上書き可能です。削除してから追加し直す操作は不要であり、set-urlコマンドだけで完結します。
もしURLだけではなくリモート名も間違えてしまった時は、git remote renameで名前を変更する対処も有効です。状況に合わせて、適切な修正コマンドを選択する流れとなります。
不要になったリモート設定を削除できますか?
不要になった設定は、git remote removeコマンドを用いてローカルから削除できます(git remote rmはremoveのエイリアスであり、どちらも同じ動作をします)。古い移行元のリポジトリなど、今後アクセスしない参照先を整理したい場面で役立つ機能です。
この操作で削除されるのはあくまでローカル上の設定のみであり、リモート本体のデータが消えるわけではありません。誤って削除した際も、再度追加コマンドを実行すれば復旧できる仕組みです。
変更後に接続エラーが出る時の対処法はありますか?
接続エラーが発生した際は、まずgit remote -vを実行して設定されたURLが正しい文字列か確認します。HTTPSからSSHへ切り替えた直後は、SSH公開鍵の登録やssh-agentの設定が完了しているかも確認してください。
URL自体に問題がない場合は、認証情報やネットワーク環境など別の要因を疑うのが解決への近道です。エラーメッセージの内容に応じた原因の切り分けが基本の対処法となります。
※上記コンテンツの内容やソースコードはAIで確認・デバッグしておりますが、間違いやエラー、脆弱性などがある場合は、コメントよりご報告いただけますと幸いです。
