forgelink

Generate shareable URLs to files and line ranges in hosted git repositories, from the command line.

Inspired by the Emacs package git-link.

Supported Forges

• GitHub
• GitLab
• SourceHut
• Bitbucket
• Codeberg (including forge.fedoraproject.org)

Installation

cargo install forgelink-cli

This installs a binary named forgelink.

Usage

Use print to generate a stable URL pinned to the current commit SHA:

$ forgelink print src/main.rs
https://github.com/user/repo/blob/abc123def.../src/main.rs

Append :N for a single line or :N-M for a range:

$ forgelink print src/main.rs:42
https://github.com/user/repo/blob/abc123def.../src/main.rs#L42

$ forgelink print src/main.rs:42-55
https://github.com/user/repo/blob/abc123def.../src/main.rs#L42-L55

Target a remote other than origin with --remote:

$ forgelink print --remote upstream src/main.rs
https://github.com/upstream-owner/repo/blob/abc123def.../src/main.rs

Use the current branch name instead of the commit SHA with --branch:

$ forgelink print --branch src/main.rs
https://github.com/user/repo/blob/main/src/main.rs

--branch requires HEAD to be on a named branch. It errors on a detached HEAD, which includes Jujutsu (jj) working copies. Use the default commit-pinned link in that case.

Copy the URL to the clipboard with copy:

forgelink copy src/main.rs

Open the URL in your default browser with open:

forgelink open src/main.rs

copy and open do not print the URL. Use print when you want stdout. When available, all subcommands support the same --remote and --branch options.

Clipboard and browser support are default-on cargo features (clipboard and browser). Build with --no-default-features to drop the arboard and open dependencies, which also removes the copy and open subcommands. On Linux under X11 the clipboard is owned by the running process, so the copied URL may not persist after forgelink exits. macOS and Windows are unaffected.

It works from any subdirectory inside the repository:

$ cd src && forgelink print main.rs
https://github.com/user/repo/blob/abc123def.../src/main.rs

You can also pass an absolute path to link to a file in any repository, regardless of your current directory:

$ forgelink print ~/Developer/other-repo/src/main.rs
https://github.com/user/other-repo/blob/abc123def.../src/main.rs

Editor integration

The file argument accepts path:line syntax, so any editor that can run a shell command with the current buffer path and cursor line can bind it with no plugin required. Use copy to copy directly, or print to capture stdout yourself.

Helix

In ~/.config/helix/config.toml:

[keys.normal.space]
o = ":sh forgelink copy \"%{file_path_absolute}:%{cursor_line}\""

space o copies a link to the current line. %{file_path_absolute} is used so it works regardless of the directory Helix was launched from.

If you are using a version released before helix-editor/helix#12989 was merged (i.e.: 25.07.1), you should use %{buffer_name} in place of %{file_path_absolute}.

Kakoune

In ~/.config/kak/kakrc:

define-command -docstring 'copy a forge link to the current line' forge-link %{
    nop %sh{ forgelink copy "$kak_buffile:$kak_cursor_line" }
}
map global user o ': forge-link<ret>' -docstring 'forge link'

Neovim

The following is a Lua implementation for using forgelink in Neovim. It copies a link to the file path in normal mode and a link to the line(s) selected in visual mode to the system clipboard.

if vim.fn.exepath('forgelink') ~= '' then
    vim.keymap.set('n', '<leader>cf',
        function()
            local curFile = vim.api.nvim_buf_get_name(0)
            local output = vim.fn.system({ 'forgelink', 'print', curFile })
            vim.fn.setreg('+', vim.trim(output))
        end,
        { desc = "Copy URL to Git forge for current file to clipboard" }
    )
    vim.keymap.set('v', '<leader>cf',
        function()
            vim.api.nvim_feedkeys(vim.api.nvim_replace_termcodes("<Esc>", true, false, true), "x", false)
            local curFile = vim.api.nvim_buf_get_name(0)
            local startLine = vim.fn.line("'<")
            local endLine = vim.fn.line("'>")
            local lineRef = startLine == endLine and tostring(startLine) or (startLine .. '-' .. endLine)
            local output = vim.fn.system({ 'forgelink', 'print', curFile .. ':' .. lineRef })
            vim.fn.setreg('+', vim.trim(output))
        end,
        { desc = "Copy URL to Git forge for current file with selected line numbers to clipboard" }
    )
end

License

Licensed under either of MIT or Apache-2.0 at your option.