Add support for custom SSH hostname in clone URLs (#612)

Author: gabrie30

cmd/clone.go

@@ -314,6 +314,10 @@ func cloneFunc(cmd *cobra.Command, argz []string) {
 		os.Setenv("GHORG_OUTPUT_DIR", d)
 	}
 
+	if cmd.Flags().Changed("ssh-hostname") {
+		os.Setenv("GHORG_SSH_HOSTNAME", cmd.Flag("ssh-hostname").Value.String())
+	}
+
 	if len(argz) < 1 {
 		if os.Getenv("GHORG_SCM_TYPE") == "github" && os.Getenv("GHORG_CLONE_TYPE") == "user" {
 			argz = append(argz, "")

cmd/root.go

@@ -53,6 +53,7 @@ var (
 	cronTimerMinutes             string
 	recloneServerPort            string
 	cloneDelaySeconds            string
+	sshHostname                  string
 	includeSubmodules            bool
 	skipArchived                 bool
 	skipForks                    bool
@@ -230,6 +231,8 @@ func getOrSetDefaults(envVar string) {
 			os.Setenv(envVar, "1")
 		case "GHORG_GITHUB_TOKEN_FROM_GITHUB_APP":
 			os.Setenv(envVar, "false")
+		case "GHORG_SSH_HOSTNAME":
+			os.Setenv(envVar, "")
 		}
 	} else {
 		s := viper.GetString(envVar)
@@ -350,6 +353,7 @@ func InitConfig() {
 	getOrSetDefaults("GHORG_GITEA_TOKEN")
 	getOrSetDefaults("GHORG_SOURCEHUT_TOKEN")
 	getOrSetDefaults("GHORG_INSECURE_GITEA_CLIENT")
+	getOrSetDefaults("GHORG_SSH_HOSTNAME")
 	getOrSetDefaults("GHORG_GITHUB_APP_PEM_PATH")
 	getOrSetDefaults("GHORG_GITHUB_APP_INSTALLATION_ID")
 	getOrSetDefaults("GHORG_GITHUB_APP_ID")
@@ -427,8 +431,10 @@ func init() {
 	cloneCmd.Flags().StringVarP(&githubFilterLanguage, "github-filter-language", "", "", "GHORG_GITHUB_FILTER_LANGUAGE - Filter repos by a language. Can be a comma separated value with no spaces.")
 	cloneCmd.Flags().StringVarP(&githubUserOption, "github-user-option", "", "", "GHORG_GITHUB_USER_OPTION - Only available when also using GHORG_CLONE_TYPE: user e.g. --clone-type=user can be one of: all, owner, member (default: owner)")
 	cloneCmd.Flags().StringVarP(&githubAppID, "github-app-id", "", "", "GHORG_GITHUB_APP_ID -  GitHub App ID, for authenticating with GitHub App")
+	cloneCmd.Flags().StringVar(&sshHostname, "ssh-hostname", "", "GHORG_SSH_HOSTNAME - Hostname to use for SSH clone URLs (e.g., my-github-alias for git@my-github-alias:org/repo.git)")
 
 	reCloneCmd.Flags().StringVarP(&ghorgReClonePath, "reclone-path", "", "", "GHORG_RECLONE_PATH - If you want to set a path other than $HOME/.config/ghorg/reclone.yaml for your reclone configuration")
+	reCloneCmd.Flags().StringVar(&sshHostname, "ssh-hostname", "", "GHORG_SSH_HOSTNAME - Hostname to use for SSH clone URLs (e.g., my-github-alias for git@my-github-alias:org/repo.git)")
 	reCloneCmd.Flags().BoolVar(&ghorgReCloneQuiet, "quiet", false, "GHORG_RECLONE_QUIET - Quiet logging output")
 	reCloneCmd.Flags().BoolVar(&ghorgReCloneList, "list", false, "Prints reclone commands and optional descriptions to stdout then will exit 0. Does not obsfucate tokens, and is only available as a commandline argument")
 	reCloneCmd.Flags().BoolVar(&ghorgReCloneEnvConfigOnly, "env-config-only", false, "GHORG_RECLONE_ENV_CONFIG_ONLY - Only use environment variables to set the configuration for all reclones.")

sample-conf.yaml

@@ -13,6 +13,14 @@ GHORG_SCM_TYPE: github
 # flag (--protocol) eg: --protocol=https
 GHORG_CLONE_PROTOCOL: https
 
+# Override SSH hostname in clone URLs. Useful when you have multiple SSH host
+# aliases in your ~/.ssh/config for the same SCM provider.
+# For example, setting this to "my-github-alias" will change clone URLs from:
+#   git@github.com:org/repo.git  ->  git@my-github-alias:org/repo.git
+# Only applies when using SSH clone protocol (--protocol=ssh)
+# flag (--ssh-hostname) eg: --ssh-hostname=my-github-alias
+GHORG_SSH_HOSTNAME:
+
 # This is where your ghorg directory will be created, use absolute pathing, shell expansions will not work.
 # The ghorg directory is the home for all ghorg clones
 # See https://github.com/gabrie30/ghorg#changing-clone-directories for example

scm/bitbucket.go

@@ -361,7 +361,7 @@ func (c Bitbucket) filter(resp []bitbucket.Repository) (repoData []Repo, err err
 
 			if os.Getenv("GHORG_CLONE_PROTOCOL") == "ssh" && linkType == "ssh" {
 				r.URL = link.(string)
-				r.CloneURL = link.(string)
+				r.CloneURL = ReplaceSSHHostname(link.(string), os.Getenv("GHORG_SSH_HOSTNAME"))
 				cloneData = append(cloneData, r)
 			} else if os.Getenv("GHORG_CLONE_PROTOCOL") == "https" && linkType == "https" {
 				r.URL = link.(string)

scm/filter.go

@@ -2,6 +2,7 @@ package scm
 
 import (
 	"os"
+	"regexp"
 	"strings"
 )
 
@@ -23,3 +24,16 @@ func hasMatchingTopic(rpTopics []string) bool {
 	// If no user defined topics are specified, accept any topics
 	return true
 }
+
+// ReplaceSSHHostname replaces the hostname in an SSH clone URL with a custom hostname.
+// This allows users to leverage SSH configs with multiple host aliases.
+// For example: git@gitlab.com:org/repo.git -> git@my-gitlab-alias:org/repo.git
+func ReplaceSSHHostname(sshURL string, newHostname string) string {
+	if newHostname == "" {
+		return sshURL
+	}
+
+	// Match SSH URLs in the format git@hostname:path or git@hostname/path
+	re := regexp.MustCompile(`^git@([^:/]+)([:\/])`)
+	return re.ReplaceAllString(sshURL, "git@"+newHostname+"$2")
+}

scm/filter_test.go

@@ -110,3 +110,68 @@ func TestMatchingTopicsWithMultipleEnvTopics(t *testing.T) {
 
 	os.Setenv("GHORG_TOPICS", "")
 }
+
+func TestReplaceSSHHostname(t *testing.T) {
+	t.Run("When newHostname is empty, return original URL unchanged", func(tt *testing.T) {
+		originalURL := "git@github.com:org/repo.git"
+		want := originalURL
+		got := ReplaceSSHHostname(originalURL, "")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When replacing GitHub SSH hostname with colon separator", func(tt *testing.T) {
+		originalURL := "git@github.com:org/repo.git"
+		want := "git@my-github-alias:org/repo.git"
+		got := ReplaceSSHHostname(originalURL, "my-github-alias")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When replacing GitLab SSH hostname", func(tt *testing.T) {
+		originalURL := "git@gitlab.com:group/subgroup/repo.git"
+		want := "git@custom.gitlab.host:group/subgroup/repo.git"
+		got := ReplaceSSHHostname(originalURL, "custom.gitlab.host")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When replacing Bitbucket SSH hostname", func(tt *testing.T) {
+		originalURL := "git@bitbucket.org:workspace/repo.git"
+		want := "git@bitbucket-alias:workspace/repo.git"
+		got := ReplaceSSHHostname(originalURL, "bitbucket-alias")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When replacing self-hosted GitLab SSH hostname", func(tt *testing.T) {
+		originalURL := "git@gitlab.example.com:org/repo.git"
+		want := "git@my-gitlab:org/repo.git"
+		got := ReplaceSSHHostname(originalURL, "my-gitlab")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When URL has slash separator instead of colon", func(tt *testing.T) {
+		originalURL := "git@git.sr.ht/~user/repo"
+		want := "git@sourcehut-alias/~user/repo"
+		got := ReplaceSSHHostname(originalURL, "sourcehut-alias")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+
+	t.Run("When hostname has subdomain", func(tt *testing.T) {
+		originalURL := "git@git.company.example.com:org/repo.git"
+		want := "git@my-gitlab:org/repo.git"
+		got := ReplaceSSHHostname(originalURL, "my-gitlab")
+		if want != got {
+			tt.Errorf("Expected %v, got: %v", want, got)
+		}
+	})
+}

scm/gitea.go

@@ -200,7 +200,7 @@ func (c Gitea) filter(rps []*gitea.Repository) (repoData []Repo, err error) {
 			r.URL = cloneURL
 			repoData = append(repoData, r)
 		} else {
-			r.CloneURL = rp.SSHURL
+			r.CloneURL = ReplaceSSHHostname(rp.SSHURL, os.Getenv("GHORG_SSH_HOSTNAME"))
 			r.URL = rp.SSHURL
 			repoData = append(repoData, r)
 		}

scm/github.go

@@ -247,7 +247,7 @@ func (c Github) filter(allRepos []*github.Repository) []Repo {
 			r.URL = *ghRepo.CloneURL
 			repoData = append(repoData, r)
 		} else {
-			r.CloneURL = *ghRepo.SSHURL
+			r.CloneURL = ReplaceSSHHostname(*ghRepo.SSHURL, os.Getenv("GHORG_SSH_HOSTNAME"))
 			r.URL = *ghRepo.SSHURL
 			repoData = append(repoData, r)
 		}

scm/gitlab.go

@@ -170,7 +170,8 @@ func (c Gitlab) createRepoSnippetCloneURL(cloneTargetURL string, snippetID strin
 	// git@gitlab.example.com/snippets/1.git
 	cloneURL = strings.Replace(cloneURL, "/", ":", 1)
 	// git@gitlab.example.com:snippets/1.git
-	return cloneURL
+	// Apply custom SSH hostname if configured
+	return ReplaceSSHHostname(cloneURL, os.Getenv("GHORG_SSH_HOSTNAME"))
 }
 
 // hosted example
@@ -192,7 +193,8 @@ func (c Gitlab) createRootLevelSnippetCloneURL(snippetWebURL string) string {
 	// git@gitlab.example.com/snippets/1.git
 	cloneURL = strings.Replace(cloneURL, "/", ":", 1)
 	// git@gitlab.example.com:snippets/1.git
-	return cloneURL
+	// Apply custom SSH hostname if configured
+	return ReplaceSSHHostname(cloneURL, os.Getenv("GHORG_SSH_HOSTNAME"))
 }
 
 func (c Gitlab) getRepoSnippets(r Repo) []*gitlab.Snippet {
@@ -557,7 +559,7 @@ func (c Gitlab) filter(group string, ps []*gitlab.Project) []Repo {
 			r.URL = p.HTTPURLToRepo
 			repoData = append(repoData, r)
 		} else {
-			r.CloneURL = p.SSHURLToRepo
+			r.CloneURL = ReplaceSSHHostname(p.SSHURLToRepo, os.Getenv("GHORG_SSH_HOSTNAME"))
 			r.URL = p.SSHURLToRepo
 			repoData = append(repoData, r)
 		}

scm/sourcehut.go

@@ -266,6 +266,8 @@ func (c Sourcehut) filter(rps []repository, apiUsername string, localUsername st
 			}
 			// Use repoPathWithTilde for clone URL (git needs the ~ prefix)
 			r.CloneURL = fmt.Sprintf("%s:%s", gitBase, repoPathWithTilde)
+			// Apply custom SSH hostname if configured
+			r.CloneURL = ReplaceSSHHostname(r.CloneURL, os.Getenv("GHORG_SSH_HOSTNAME"))
 		}
 
 		r.URL = r.CloneURL