vscode

Git Web Links for VS Code

Copy links to files in their online Git repositories from inside Visual Studio Code.

Works with:

• Azure DevOps Cloud and Server
• Bitbucket Cloud and Server
• Gitea
• GitHub and GitHub Enterprise
• Gitiles (Gerrit)
• GitLab (SaaS, Community Edition and Enterprise Edition)
• Visual Studio Team Services

For on-premise hosts (for example, GitLab CE, Bitbucket Server, etc), there is some configuration required. See below for more details.

Copy a Link to a File

To copy a link to the file, right-click on the file's tab and select Copy Link to File.

You can also right-click on a file in Explorer panel and select Copy Link to File.

Copy a Link to the Selection

To copy a link to a particular line in the file, right-click on the line in the editor and select Copy Link to Selection. You can also use the shortcut Ctrl+Alt+L on Windows and Linux, and Ctrl+Cmd+L on macOS.

If you want to copy a link to a range of lines, just select the lines first.

Copy a Link to a Specific Branch or Commit

If the current commit, current branch of default branch is not suitable, you can choose which commit or branch to copy a link to by using the Copy Link to Selection (choose type) command from the command palette.

This command can be useful if you need to share a link to code that is not on the default branch, and your current branch has not been pushed to the server. For example, your current branch may have branched off an "epic" branch but has not been pushed to the server. You can use this command to create a link to the "epic" branch.

The caveat with this command is that if the code you are linking to is different between your current branch and the branch or commit you are linking to, the link may be invalid.

Open the File from a Link

You can also go in the opposite direction. Starting from a link, you can navigate to the file that the link refers to using the Go To File command.

Run the command then paste the link into the prompt to navigate to the file.

Default Link Format

The commands above will create links using either the current commit hash, the current branch name or the default branch name.

The current commit hash is the default format. This can be changed using the gitweblinks.linkType setting.

"gitweblinks.linkType": "commit"

The default branch is found by using the remote's HEAD ref (for example, origin/HEAD), but you can specify a specific branch name to use as the default by using the gitweblinks.defaultBranch setting.

Specifying a Link Format

In addition to the commands mentioned above, there are three commands available in the Command Palette that allow you to create a link in a specific format, rather than using the default format.

Open in Browser

You can choose to open the links directly in the browser instead of copying to the clipboard. The menu item is hidden by default. To show this menu item, set the gitweblinks.showOpen setting to true.

You can also hide the "Copy Link" menu items by setting the gitweblinks.showCopy to false.

On-Premise Servers

If you use an on-premise server, you will need to specify the URLs of those servers in your settings file. You need to specify the base HTTP/HTTPS URL of the server, and if you use SSH, the base SSH URL.

Make sure you include any port numbers (if it's not port 80) and context paths.

Azure DevOps Server

"gitweblinks.azureDevOpsServer": [
    {
        "http": "https://local-devops",
        "ssh": "git@local-devops"
    }
]

Bitbucket Server

"gitweblinks.bitbucketServer": [
    {
        "http": "https://local-bitbucket:7990/context",
        "ssh": "git@local-bitbucket:7999"
    }
]

Gitea

"gitweblinks.gitea": [
    {
        "http": "https://my.gitea.server:3000",
        "ssh": "ssh://my.gitea.server"
    }
]

GitHub Enterprise

"gitweblinks.gitHubEnterprise": [
    {
        "http": "https://local-github",
        "ssh": "git@local-github"
    }
]

Gitiles

"gitweblinks.gitiles": [
    {
        "http": "https://git.mygitiles.com:8080/plugins/gitiles",
        "ssh": "ssh://git.mygitiles.com:29418"
    }
]

GitLab Enterprise/Community Edition

"gitweblinks.gitLabEnterprise": [
    {
        "http": "https://local-gitlab",
        "ssh": "git@local-gitlab"
    }
]

Requirements

This extension requires Git to already be installed and on your PATH.

Which Link Format Should I Use?

There are three types of links that can be produced, and each have their advantages and disadvantages.

commit

This is the default format, and will create a link using the current commit's hash.

This is great for producing permalinks, but it can lead to 404s if your current commit hasn't been pushed to the remote.

branch

This will create a link using the name of the branch that is currently checked out.

This is good if you only need the link to be useful for a short period of time (for example, sharing a link via email or instant messaging), but it's not great for producing permalinks - if the code on that branch changes in the future, the link may become invalid.

defaultBranch

This will create a link using the name of the default branch, rather than the name of the branch that is currently checked out. The name of the default branch is discovered using the remote's HEAD ref, but you can also choose a specific branch name to use by setting the gitweblinks.defaultBranch setting.

Like the "branch" type, this type of link is also useful for sharing via email or instant messaging, but because it uses the default branch name rather than the name of the current branch, it's particularly useful if you've created a branch locally that does not exist on the server.

The only caveat with this type of link is that the code on the branch that is currently checked out might be different to the code on the default branch, which may lead to an invalid link.