xiaoyawei / gitlink

A Jetbrains plugin that opens a local file under Git version control in its remote host using the default browser.

GitLink

A Jetbrains plugin providing shortcuts to open or copy a file, directory or commit in GitHub, Bitbucket, GitLab, Gitee Gitea, Gogs or Azure. Custom hosts can also be configured using the URL template syntax.

Usage

Install the plugin and configure your remote host if it hasn't been auto-detected already:

  Preferences → Tools → GitLink

Make sure you have registered your projects root under the version control preferences:

  Preferences → Version Control (see unregistered roots)

To open the current file in the default browser:

  View → Open in (your selected host) or
  Select in... → Browser (GitLink)

Additional shortcuts are available including from the editor gutter and Git log window.

A URL can be generated in one of the following ways:

• File at a commit
• File at a branch
• Commit

By default, when generating a URL to a file, the latest commit hash is used, creating a reference to a fixed version of the file's content. If the latest commit has not been pushed to the remote, the current branch is used instead. While this avoids generating a URL to a 404, it does mean the linked contents can change over time.

Installation

• Using IDE built-in plugin system:

  Settings/Preferences > Plugins > Marketplace > Search for "GitLink" > Install Plugin

• Manually:

  Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Support

• Star the repository
• Rate the plugin
• Share the plugin
• Become a Backer or Sponsor

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

Please see LICENSE for details.