https://github.com/ben-gibson/GitLink

A Jetbrains plugin that opens a local file under Git version control in its remote host using the default browser.
https://github.com/ben-gibson/GitLink

azure-devops bitbucket git gitee github gitlab gitlink jetbrains-plugin plugin vcs

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ben-gibson/GitLink
• Owner: ben-gibson
• License: mit
• Created: 2016-01-26T18:08:21.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-07T08:39:21.000Z (5 months ago)
• Last Synced: 2024-10-30T00:33:40.579Z (3 months ago)
• Topics: azure-devops, bitbucket, git, gitee, github, gitlab, gitlink, jetbrains-plugin, plugin, vcs
• Language: Kotlin
• Homepage: https://plugins.jetbrains.com/plugin/8183-gitlink
• Size: 5.64 MB
• Stars: 738
• Watchers: 9
• Forks: 59
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitLink

![Build](https://github.com/ben-gibson/GitLink/workflows/Build/badge.svg)

[![Version](https://img.shields.io/jetbrains/plugin/v/8183-gitlink.svg)](https://plugins.jetbrains.com/plugin/8183-gitlink)

[![Rating](https://img.shields.io/jetbrains/plugin/r/stars/8183-gitlink.svg)](https://plugins.jetbrains.com/plugin/8183-gitlink)

[![Downloads](https://img.shields.io/jetbrains/plugin/d/8183-gitlink.svg)](https://plugins.jetbrains.com/plugin/8183-gitlink)

[![Donations](https://opencollective.com/gitlink/tiers/badge.svg?label=sponsor&color=brightgreen)](https://opencollective.com/gitlink)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

A [Jetbrains plugin](https://plugins.jetbrains.com/plugin/8183-gitlink) providing shortcuts to open or copy a file, directory or commit in `GitHub`, `Bitbucket`, 

`GitLab`, `Gitee` `Gitea`, `Gogs`, `Azure`, `sourcehut`, and `Gerrit`. 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](https://github.com/ben-gibson/GitLink/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

## Support

* Star the repository

* [Rate the plugin](https://plugins.jetbrains.com/plugin/8183-gitlink)

* [Share the plugin](https://plugins.jetbrains.com/plugin/8183-gitlink)

* [Become a Backer or Sponsor](https://opencollective.com/gitlink)

  

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## License

Please see [LICENSE](LICENSE) for details.