git-permalink - README


pt | fr | eo

Git extension to generate web permalinks of files in a repository.

It knows about many of the existing code forges, but allows for URL template overrides to be used on custom domains or deployments via git config.


# setup example "remembering" repository
$ git clone git://
$ cd remembering/

Now inside the repository folder, running git permalink will try building the web URL of the given file and use xdg-open to launch the browser (or whatever is configured):

$ git permalink tests/
$ git permalink tests/ 23

Or if you just want to output the link without invoking xdg-open, you can use the -p flag:

$ git permalink -p tests/ 23


$ make
$ make check
# make install

You can pass PREFIX or DESTDIR to make if you'd like:

$ make
$ make check
$ make install PREFIX=$HOME/.local

There are no dependencies or requirements, only standard tools such as POSIX sed, POSIX make, etc.



The documentation is available via installed manpages or online:

Directory structure

The directory structure of the repository is:


Extra tools used for development are:

For running the extra development-only checks, run:

$ make dev-check

and for generating the documentation HTML and website, run:

$ make public

Send contributions to the mailing list via git send-email.




The code is licensed under GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).