git remoteで、リモートの登録・URL変更・削除をする方法

​​Git​コマンドライン

git remote add でリモートに名前を付けて登録し、git remote set-url で URL を書き換え、git remote remove で登録を消します。手元のリポジトリを GitHub などに作った空のリポジトリへ初めてプッシュするとき、リポジトリの引っ越しで URL が変わったとき、HTTPS から SSH の URL に切り替えるときに使う操作です。それぞれの前と後で git remote -v などの出力がどう変わるかを、検証環境で実行して確かめました。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定しました。リモートには、同じ環境に作ったベアリポジトリ(../old.git、../new.git、../backup.git)を使いました。https://example.com/... と git@example.com:... の URL は、登録を書き換えて表示を確かめただけで、接続はしていません。GitHub などのホスティングサービスへのプッシュ、SSH 鍵の設定、Windows と macOS での動作は試していません。

リモートを登録する前の状態

git init しただけのリポジトリには、リモートが1つもありません。git remote も git remote -v も何も出さず、git push は送り先がないと言って止まります。

console
$ git remote

$ git remote -v

$ git push
fatal: No configured push destination.
Either specify the URL from the command-line or configure a remote repository using

    git remote add <name> <url>

and then push using the remote name

    git push <name>

git remote add で登録する

git remote add <名前> <URL> で登録します。名前は何でもよいのですが、git clone はクローン元を origin という名前で登録します(Pro Git 日本語版の「リモートでの作業」)。ここでも origin にしました。

console
$ git remote add origin ../old.git

$ git remote
origin

$ git remote -v
origin	../old.git (fetch)
origin	../old.git (push)

git remote は名前だけを並べ、-v を付けると名前の後ろに URL も出します(git remote の公式リファレンス)。(fetch) は取ってくるときの URL、(push) は送るときの URL です。ここでは同じ URL が2行出ています。

登録した内容は、リポジトリの設定(.git/config)に書かれます。git config で見ると、URL と、取ってきたブランチを origin/ブランチ名 として置くための設定が入っていました。

console
$ git config --get-regexp "^remote\."
remote.origin.url ../old.git
remote.origin.fetch +refs/heads/*:refs/remotes/origin/*

登録しただけでは、まだ何も送られていません。初めてのプッシュでは -u を付けると、main が origin/main を追跡するように設定され、次からは git push だけで送れます(git push の公式リファレンス)。

console
$ git push -u origin main
To ../old.git
 * [new branch]      main -> main
branch 'main' set up to track 'origin/main'.

$ git branch -vv
* main 6b9961f [origin/main] 最初のコミット

$ git branch -r
  origin/main

「remote origin already exists」と出たとき

すでにある名前で git remote add をすると、エラーになって何も変わりません。

console
$ git remote add origin ../new.git
error: remote origin already exists.

origin の URL を変えたいだけなら、次の set-url を使います。別の場所をもう1つ登録したいなら、backup のような別の名前で add します。

git remote set-url で URL を変える

リポジトリが ../old.git から ../new.git に引っ越した、という場面です。引っ越し先は git clone --bare で作り、中身は同じにしてあります。いまの URL は git remote get-url で確かめられます。

console
$ git remote get-url origin
../old.git

$ git remote set-url origin ../new.git

$ git remote -v
origin	../new.git (fetch)
origin	../new.git (push)

(fetch) と (push) の両方が新しい URL になりました。名前は origin のままなので、main の追跡の設定もそのまま使えます。コミットを1つ足して git push だけを打つと、新しい URL に送られました。

console
$ echo "version: 1.0.0" > app.txt

$ git add app.txt && git commit -q -m "1.0.0 の準備"

$ git push
To ../new.git
   6b9961f..3d7c916  main -> main

$ git ls-remote ../new.git
3d7c9163590ba2e187417493f0142cd7cb580d29	HEAD
3d7c9163590ba2e187417493f0142cd7cb580d29	refs/heads/main

$ git ls-remote ../old.git
6b9961f33795cabbae067b1810a43c9c421b513c	HEAD
6b9961f33795cabbae067b1810a43c9c421b513c	refs/heads/main

新しいコミット 3d7c916 は ../new.git にだけ入り、../old.git は 6b9961f のままです。set-url は手元の登録を書き換えるだけで、古い場所には何もしません。

HTTPS の URL を SSH の URL に切り替える

HTTPS と SSH の切り替えも、同じ set-url で行います。

console
$ git remote set-url origin https://example.com/neko/app.git

$ git remote -v
origin	https://example.com/neko/app.git (fetch)
origin	https://example.com/neko/app.git (push)

$ git remote set-url origin git@example.com:neko/app.git

$ git remote -v
origin	git@example.com:neko/app.git (fetch)
origin	git@example.com:neko/app.git (push)

set-url は、URL の先につながるかを確かめずに書き換えます。存在しない ../nai.git を指定しても set-url はそのまま終わり、次の git fetch で初めてエラーになりました。

console
$ git remote set-url origin ../nai.git

$ git fetch origin
fatal: '../nai.git' does not appear to be a git repository
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

$ git remote set-url origin ../new.git

$ git fetch origin

URL を書き換えた後に git fetch を1回実行すれば、新しい URL から取ってこられるかを確かめられます。正しい URL に戻した後の git fetch は、エラーを出さずに終わりました。

登録していない名前を指定すると、エラーになります。

console
$ git remote set-url upstream ../new.git
error: No such remote 'upstream'

git remote remove で登録を消す

消す前に、2つ目のリモート backup を登録して main を送っておきます。

console
$ git remote add backup ../backup.git

$ git push -q backup main

$ git remote -v
backup	../backup.git (fetch)
backup	../backup.git (push)
origin	../new.git (fetch)
origin	../new.git (push)

$ git branch -r
  backup/main
  origin/main

git remote remove で backup を消します。

console
$ git remote remove backup

$ git remote -v
origin	../new.git (fetch)
origin	../new.git (push)

$ git branch -r
  origin/main

$ git config --get-regexp "^remote\."
remote.origin.url ../new.git
remote.origin.fetch +refs/heads/*:refs/remotes/origin/*

登録だけでなく、backup/main も消えました。git remote の公式リファレンスにも、そのリモートの追跡ブランチ(remote-tracking branch)と設定がすべて消えると書かれています。

一方で、リモートのリポジトリそのものは消えません。../backup.git を直接見ると、送った main が残っています。

console
$ git ls-remote ../backup.git
3d7c9163590ba2e187417493f0142cd7cb580d29	HEAD
3d7c9163590ba2e187417493f0142cd7cb580d29	refs/heads/main

もう一度同じ名前を消そうとすると、エラーになります。

console
$ git remote remove backup
error: No such remote: 'backup'

remove の代わりに rm と書いても同じです。

ブランチが追跡しているリモートを消したとき

main は origin/main を追跡しています。その設定は、ブランチ側の branch.main.remote と branch.main.merge に入っています。この状態で origin を消すと、ブランチ側の設定も消えました。

console
$ git config --get-regexp "^branch\."
branch.main.remote origin
branch.main.merge refs/heads/main

$ git remote rm origin

$ git config --get-regexp "^branch\."

$ git branch -vv
* main 3d7c916 1.0.0 の準備

$ git push
fatal: No configured push destination.
Either specify the URL from the command-line or configure a remote repository using

    git remote add <name> <url>

and then push using the remote name

    git push <name>

git branch -vv から [origin/main] が消え、git push は登録する前と同じエラーに戻りました。

同じ名前で登録し直しても、追跡の設定は戻りませんでした。この時点ではまだ origin/main を取ってきていないので、git branch -u で追跡先に指定しようとしてもエラーになります。

console
$ git remote add origin ../new.git

$ git branch -vv
* main 3d7c916 1.0.0 の準備

$ git config --get-regexp "^branch\."

$ git branch -u origin/main
fatal: the requested upstream branch 'origin/main' does not exist
hint: 
hint: If you are planning on basing your work on an upstream
hint: branch that already exists at the remote, you may need to
hint: run "git fetch" to retrieve it.
hint: 
hint: If you are planning to push out a new local branch that
hint: will track its remote counterpart, you may want to use
hint: "git push -u" to set the upstream config as you push.
hint: Disable this message with "git config advice.setUpstreamFailure false"

git fetch で origin/main を取ってきてから、git branch -u で設定し直すと、追跡の設定が戻りました(git branch の公式リファレンス)。

console
$ git fetch -q origin

$ git branch -u origin/main
branch 'main' set up to track 'origin/main'.

$ git branch -vv
* main 3d7c916 [origin/main] 1.0.0 の準備
ポイント

URL を変えたいだけなら、remove して add し直すより set-url のほうが手間がかかりません。名前が残るので、ブランチの追跡の設定も消えません。

​Posted by 86