Skip to content

Instantly share code, notes, and snippets.

@Kovrinic

Kovrinic/.gitconfig

Last active October 10, 2025 19:36
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save Kovrinic/ea5e7123ab5c97d451804ea222ecd78a to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save Kovrinic/ea5e7123ab5c97d451804ea222ecd78a to your computer and use it in GitHub Desktop.
Download ZIP
git global url insteadOf setup
Raw
.gitconfig
# one or the other, NOT both
[url "https://github"]
insteadOf = git://github
# or
[url "[email protected]:"]
insteadOf = git://github
Raw
readme.md
@pklapperich
Copy link

pklapperich commented May 11, 2023

Do you know how to set up with custom port? the default is 22

you have two options. In the below examples, the match is specific to an organization (ex you want to force ssh when working with your company's projects but https is fine for public projects). Just filter on and replace less if you want less.

Option 1: Entirely in gitconfig. The ssh:// is required to change ports.

# ~/.gitconfig
[url "ssh://[email protected]:1234/organization"]
  insteadOf = https://github.com/organization

Option 2: Use replacement in git config as well as replacement in ssh config.

# ~/.gitconfig
[url "[email protected]:/organization"]
  insteadOf = https://github.com/organization
```

```
# ~/.ssh/config
Host github.com github
    Hostname github.com
    User git
    Port 1234
```

Basically anything that you can set with `-o [optionName]` on the ssh commandline can be set via the config file. The line `Host` is space separated list of matching names that you type on the commandline (ex: `ssh github`) or use in URLs for things that use ssh under the hood (rsync, git, svn, etc). The `Hostname ...` option is the hostname that's used in-place-of what was matched.

@jasong-au
Copy link

jasong-au commented Oct 10, 2024

Any way to debug this? I'm trying to set something up for 'go install' to use a private repository and personal access token, but I can never tell if it is being called or not.

@pklapperich
Copy link

pklapperich commented Oct 19, 2024

@jasong-au Any time git is called, it'll check the ~/.gitconfig file for matches based on insteadOf. This includes if go install is using git under the hood. Any time ssh is called, it'll check ~/.ssh/config for matching host definitions. This includes if git is using ssh under the hood.

So you can debug a ~/.ssh/config file using ssh, such as ssh github or ssh github.com and ensure it uses the hostname, username, and port defined in the config file.

You can debug a ~/.gitconfig using git.

Do something like this:

$ cat ~/.gitconfig
[url "https://gist.github.com/ea5e7123ab5c97d451804ea222ecd78a.git"]
   insteadOf = http://jasong-au

$ git clone http://jasong-au
Cloning into 'jasong-au'...
remote: Enumerating objects: 15, done.
remote: Total 15 (delta 0), reused 0 (delta 0), pack-reused 15 (from 1)
Receiving objects: 100% (15/15), done.
Resolving deltas: 100% (3/3), done.
(base)

Just make sure that whatever you put in your insteadOf = clause properly matches a URL for a git repo that go install is trying to access. And keep in mind that it's a find/replace matching from the start of the string, so you can swap any part of the start of the URL you want, including the entire URL. In my config I swap https://ourserver.organziation.example.com matching based on insteadOf = https://github.com/organization/ because we moved away from github and now have our own internal git server. By setting up the url mapping I didn't have to go through and update the URL for every repo already cloned on my workstation.

@orange723
Copy link

orange723 commented Apr 15, 2025

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment