feat: add fork remote command

karolzwolak · karolzwolak · commit 89c3950da731 · 2025-10-26T10:04:36.000+01:00
The command allows you to quickly add a new 'fork' remote with replaced owner in the origin URL of the selected remote. For example: given url: https://github.com/jesseduffield/lazygit.git and username: karolzwolak adds a new remote with url: https://github.com/karolzwolak/lazygit.git
diff --git a/docs/Config.md b/docs/Config.md
@@ -703,6 +703,7 @@ keybinding:
     pushTag: P
     setUpstream: u
     fetchRemote: f
+    AddForkRemote: F
     sortOrder: s
   worktrees:
     viewWorktreeOptions: w
diff --git a/docs/keybindings/Keybindings_en.md b/docs/keybindings/Keybindings_en.md
@@ -316,6 +316,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` n `` | New remote |  |
 | `` d `` | Remove | Remove the selected remote. Any local branches tracking a remote branch from the remote will be unaffected. |
 | `` e `` | Edit | Edit the selected remote's name or URL. |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Fetch | Fetch updates from the remote repository. This retrieves new commits and branches without merging them into your local branches. |
 | `` / `` | Filter the current view by text |  |
 
diff --git a/docs/keybindings/Keybindings_ja.md b/docs/keybindings/Keybindings_ja.md
@@ -342,6 +342,7 @@ _凡例：`＜c-b＞` はctrl+b、`＜a-b＞` はalt+b、`B` はshift+bを意味
 | `` n `` | 新しいリモート |  |
 | `` d `` | 削除 | 選択したリモートを削除します。そのリモートからのリモートブランチを追跡しているローカルブランチは影響を受けません。 |
 | `` e `` | 編集 | 選択したリモートの名前またはURLを編集します。 |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | フェッチ | リモートリポジトリから更新をフェッチします。これにより、ローカルブランチにマージせずに新しいコミットとブランチを取得します。 |
 | `` / `` | 現在のビューをテキストでフィルタリング |  |
 
diff --git a/docs/keybindings/Keybindings_ko.md b/docs/keybindings/Keybindings_ko.md
@@ -266,6 +266,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` n `` | 새로운 Remote 추가 |  |
 | `` d `` | Remove | Remove the selected remote. Any local branches tracking a remote branch from the remote will be unaffected. |
 | `` e `` | Edit | Remote를 수정 |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Fetch | 원격을 업데이트 |
 | `` / `` | Filter the current view by text |  |
 
diff --git a/docs/keybindings/Keybindings_nl.md b/docs/keybindings/Keybindings_nl.md
@@ -294,6 +294,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` n `` | Voeg een nieuwe remote toe |  |
 | `` d `` | Remove | Remove the selected remote. Any local branches tracking a remote branch from the remote will be unaffected. |
 | `` e `` | Edit | Wijzig remote |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Fetch | Fetch remote |
 | `` / `` | Filter the current view by text |  |
 
diff --git a/docs/keybindings/Keybindings_pl.md b/docs/keybindings/Keybindings_pl.md
@@ -390,6 +390,7 @@ _Legenda: `<c-b>` oznacza ctrl+b, `<a-b>` oznacza alt+b, `B` oznacza shift+b_
 | `` n `` | Nowy zdalny |  |
 | `` d `` | Usuń | Usuń wybrany zdalny. Wszelkie lokalne gałęzie śledzące gałąź zdalną z tego zdalnego nie zostaną dotknięte. |
 | `` e `` | Edytuj | Edytuj nazwę lub URL wybranego zdalnego. |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Pobierz | Pobierz aktualizacje z zdalnego repozytorium. Pobiera nowe commity i gałęzie bez scalania ich z lokalnymi gałęziami. |
 | `` / `` | Filtruj bieżący widok po tekście |  |
 
diff --git a/docs/keybindings/Keybindings_pt.md b/docs/keybindings/Keybindings_pt.md
@@ -325,6 +325,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` n `` | Novo controle |  |
 | `` d `` | Remover | Remover o controle remoto. Quaisquer ramificações locais de rastreamento de um ramo remoto do controle não serão afetadas. |
 | `` e `` | Editar | Edit the selected remote's name or URL. |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Buscar | Fetch updates from the remote repository. This retrieves new commits and branches without merging them into your local branches. |
 | `` / `` | Filter the current view by text |  |
 
diff --git a/docs/keybindings/Keybindings_ru.md b/docs/keybindings/Keybindings_ru.md
@@ -362,6 +362,7 @@ _Связки клавиш_
 | `` n `` | Добавить новую удалённую ветку |  |
 | `` d `` | Remove | Remove the selected remote. Any local branches tracking a remote branch from the remote will be unaffected. |
 | `` e `` | Edit | Редактировать удалённый репозитории |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | Получить изменения | Получение изменения из удалённого репозитория |
 | `` / `` | Filter the current view by text |  |
 
diff --git a/docs/keybindings/Keybindings_zh-CN.md b/docs/keybindings/Keybindings_zh-CN.md
@@ -390,6 +390,7 @@ _图例：`<c-b>` 意味着ctrl+b, `<a-b>意味着Alt+b, `B` 意味着shift+b_
 | `` n `` | 添加新的远程仓库 |  |
 | `` d `` | 删除 | 删除选中的远程。从远程跟踪远程分支的任何本地分支都不会受到影响。 |
 | `` e `` | 编辑 | 编辑远程仓库 |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | 抓取 | 抓取远程仓库 |
 | `` / `` | 通过文本过滤当前视图 |  |
 
diff --git a/docs/keybindings/Keybindings_zh-TW.md b/docs/keybindings/Keybindings_zh-TW.md
@@ -390,6 +390,7 @@ _說明：`<c-b>` 表示 Ctrl＋B、`<a-b>` 表示 Alt＋B，`B`表示 Shift＋B
 | `` n `` | 新增遠端 |  |
 | `` d `` | Remove | Remove the selected remote. Any local branches tracking a remote branch from the remote will be unaffected. |
 | `` e `` | 編輯 | 編輯遠端 |
+| `` F `` | Add fork remote | Quickly add a fork remote by replacing the owner in the origin URL and optionally check out a branch from new remote. |
 | `` f `` | 擷取 | 擷取遠端 |
 | `` / `` | 搜尋 |  |
 
diff --git a/pkg/config/user_config.go b/pkg/config/user_config.go
@@ -529,6 +529,7 @@ type KeybindingBranchesConfig struct {
 	PushTag                string `yaml:"pushTag"`
 	SetUpstream            string `yaml:"setUpstream"`
 	FetchRemote            string `yaml:"fetchRemote"`
+	AddForkRemote          string `yaml:"AddForkRemote"`
 	SortOrder              string `yaml:"sortOrder"`
 }
 
@@ -985,6 +986,7 @@ func GetDefaultConfig() *UserConfig {
 				PushTag:                "P",
 				SetUpstream:            "u",
 				FetchRemote:            "f",
+				AddForkRemote:          "F",
 				SortOrder:              "s",
 			},
 			Worktrees: KeybindingWorktreesConfig{
diff --git a/pkg/gui/controllers/remotes_controller.go b/pkg/gui/controllers/remotes_controller.go
@@ -2,6 +2,8 @@ package controllers
 
 import (
 	"fmt"
+	"regexp"
+	"slices"
 	"strings"
 
 	"github.com/jesseduffield/gocui"
@@ -70,6 +72,14 @@ func (self *RemotesController) GetKeybindings(opts types.KeybindingsOpts) []*typ
 			Tooltip:           self.c.Tr.EditRemoteTooltip,
 			DisplayOnScreen:   true,
 		},
+		{
+			Key:               opts.GetKey(opts.Config.Branches.AddForkRemote),
+			Handler:           self.withItem(self.addFork),
+			GetDisabledReason: self.require(self.singleItemSelected()),
+			Description:       self.c.Tr.AddForkRemote,
+			Tooltip:           self.c.Tr.AddForkRemoteTooltip,
+			DisplayOnScreen:   true,
+		},
 		{
 			Key:               opts.GetKey(opts.Config.Branches.FetchRemote),
 			Handler:           self.withItem(self.fetch),
@@ -133,36 +143,75 @@ func (self *RemotesController) enter(remote *models.Remote) error {
 	return nil
 }
 
+// Adds a new remote and refreshes the list of remotes.
+func (self *RemotesController) addRemoteAndRefresh(remoteName string, remoteUrl string) error {
+	self.c.LogAction(self.c.Tr.Actions.AddRemote)
+	err := self.c.Git().Remote.AddRemote(remoteName, remoteUrl)
+	if err != nil {
+		return err
+	}
+
+	// Do a sync refresh of the remotes so that we can select
+	// the new one. Loading remotes is not expensive, so we can
+	// afford it.
+	self.c.Refresh(types.RefreshOptions{
+		Scope: []types.RefreshableView{types.REMOTES},
+		Mode:  types.SYNC,
+	})
+	return nil
+}
+
+// Selects the given remote in the UI, fetches it, and checks out the specified branch if profided.
+func (self *RemotesController) selectRemoteAndCheckout(remoteName string, remoteUrl string, branchToCheckout string) error {
+	// Select the remote
+	for idx, remote := range self.c.Model().Remotes {
+		if remote.Name == remoteName {
+			self.c.Contexts().Remotes.SetSelection(idx)
+			break
+		}
+	}
+
+	// Fetch the remote
+	return self.fetchAndCheckout(self.c.Contexts().Remotes.GetSelected(), branchToCheckout)
+}
+
+// Adds a new remote, refreshes and selects it, then fetches and checks out the specified branch if provided.
+func (self *RemotesController) addAndCheckoutRemote(remoteName string, remoteUrl string, branchToCheckout string) error {
+	self.addRemoteAndRefresh(remoteName, remoteUrl)
+
+	return self.selectRemoteAndCheckout(remoteName, remoteUrl, branchToCheckout)
+}
+
+// Ensures the fork remote exists (matching the given URL).
+// If it exists and matches, it’s selected and fetched; otherwise, it’s created and then fetched and checked out.
+// If it does exist but with a different URL, an error is returned.
+func (self *RemotesController) ensureForkRemoteAndCheckout(remoteName string, remoteUrl string, branchToCheckout string) error {
+	for idx, remote := range self.c.Model().Remotes {
+		if remote.Name == remoteName {
+			hasTheSameUrl := slices.Contains(remote.Urls, remoteUrl)
+			if !hasTheSameUrl {
+				return fmt.Errorf("%s", utils.ResolvePlaceholderString(
+					self.c.Tr.IncompatibleForkAlreadyExistsError,
+					map[string]string{
+						"remoteName": remoteName,
+					},
+				))
+			}
+			self.c.Contexts().Remotes.SetSelection(idx)
+			return self.fetchAndCheckout(remote, branchToCheckout)
+		}
+	}
+	return self.addAndCheckoutRemote(remoteName, remoteUrl, branchToCheckout)
+}
+
 func (self *RemotesController) add() error {
 	self.c.Prompt(types.PromptOpts{
 		Title: self.c.Tr.NewRemoteName,
 		HandleConfirm: func(remoteName string) error {
 			self.c.Prompt(types.PromptOpts{
 				Title: self.c.Tr.NewRemoteUrl,
 				HandleConfirm: func(remoteUrl string) error {
-					self.c.LogAction(self.c.Tr.Actions.AddRemote)
-					if err := self.c.Git().Remote.AddRemote(remoteName, remoteUrl); err != nil {
-						return err
-					}
-
-					// Do a sync refresh of the remotes so that we can select
-					// the new one. Loading remotes is not expensive, so we can
-					// afford it.
-					self.c.Refresh(types.RefreshOptions{
-						Scope: []types.RefreshableView{types.REMOTES},
-						Mode:  types.SYNC,
-					})
-
-					// Select the new remote
-					for idx, remote := range self.c.Model().Remotes {
-						if remote.Name == remoteName {
-							self.c.Contexts().Remotes.SetSelection(idx)
-							break
-						}
-					}
-
-					// Fetch the new remote
-					return self.fetch(self.c.Contexts().Remotes.GetSelected())
+					return self.addAndCheckoutRemote(remoteName, remoteUrl, "")
 				},
 			})
 
@@ -173,6 +222,63 @@ func (self *RemotesController) add() error {
 	return nil
 }
 
+var (
+	// 1. SCP-like SSH: git@host:owner[/subgroups]/repo(.git)
+	sshScpRegex = regexp.MustCompile(`^(git@[^:]+:)([^/]+(?:/[^/]+)*)/([^/]+?)(\.git)?$`)
+
+	// 2. SSH URL style: ssh://user@host[:port]/owner[/subgroups]/repo(.git)
+	sshUrlRegex = regexp.MustCompile(`^(ssh://[^/]+/)([^/]+(?:/[^/]+)*)/([^/]+?)(\.git)?$`)
+
+	// 3. HTTPS: https://host/owner[/subgroups]/repo(.git)
+	httpRegex = regexp.MustCompile(`^(https?://[^/]+/)([^/]+(?:/[^/]+)*)/([^/]+?)(\.git)?$`)
+)
+
+// Rewrites a Git remote URL to use the given fork username,
+// keeping the repo name and host intact. Supports SCP-like SSH, SSH URL style, and HTTPS.
+func replaceForkUsername(remoteUrl, forkUsername string) (string, error) {
+	if forkUsername == "" {
+		return "", fmt.Errorf("fork username cannot be empty")
+	}
+	if remoteUrl == "" {
+		return "", fmt.Errorf("remote URL cannot be empty")
+	}
+
+	switch {
+	case sshScpRegex.MatchString(remoteUrl):
+		return sshScpRegex.ReplaceAllString(remoteUrl, "${1}"+forkUsername+"/$3$4"), nil
+	case sshUrlRegex.MatchString(remoteUrl):
+		return sshUrlRegex.ReplaceAllString(remoteUrl, "${1}"+forkUsername+"/$3$4"), nil
+	case httpRegex.MatchString(remoteUrl):
+		return httpRegex.ReplaceAllString(remoteUrl, "${1}"+forkUsername+"/$3$4"), nil
+	default:
+		return "", fmt.Errorf("unsupported or invalid remote URL: %s", remoteUrl)
+	}
+}
+
+func (self *RemotesController) addFork(baseRemote *models.Remote) error {
+	self.c.Prompt(types.PromptOpts{
+		Title: self.c.Tr.AddForkRemoteUsername,
+		HandleConfirm: func(forkUsername string) error {
+			branchToCheckout := ""
+
+			parts := strings.SplitN(forkUsername, ":", 2)
+			if len(parts) == 2 {
+				forkUsername = parts[0]
+				branchToCheckout = parts[1]
+			}
+			baseUrl := baseRemote.Urls[0]
+			remoteUrl, err := replaceForkUsername(baseUrl, forkUsername)
+			if err != nil {
+				return err
+			}
+
+			return self.ensureForkRemoteAndCheckout(forkUsername, remoteUrl, branchToCheckout)
+		},
+	})
+
+	return nil
+}
+
 func (self *RemotesController) remove(remote *models.Remote) error {
 	self.c.Confirm(types.ConfirmOpts{
 		Title:  self.c.Tr.RemoveRemote,
@@ -244,16 +350,22 @@ func (self *RemotesController) edit(remote *models.Remote) error {
 }
 
 func (self *RemotesController) fetch(remote *models.Remote) error {
+	return self.fetchAndCheckout(remote, "")
+}
+
+func (self *RemotesController) fetchAndCheckout(remote *models.Remote, branchName string) error {
 	return self.c.WithInlineStatus(remote, types.ItemOperationFetching, context.REMOTES_CONTEXT_KEY, func(task gocui.Task) error {
 		err := self.c.Git().Sync.FetchRemote(task, remote.Name)
 		if err != nil {
 			return err
 		}
-
+		if branchName != "" {
+			err = self.c.Git().Branch.New(branchName, remote.Name+"/"+branchName)
+		}
 		self.c.Refresh(types.RefreshOptions{
 			Scope: []types.RefreshableView{types.BRANCHES, types.REMOTES},
 			Mode:  types.ASYNC,
 		})
-		return nil
+		return err
 	})
 }
diff --git a/pkg/gui/controllers/remotes_controller_test.go b/pkg/gui/controllers/remotes_controller_test.go
diff --git a/pkg/i18n/english.go b/pkg/i18n/english.go
diff --git a/schema/config.json b/schema/config.json
