blob: 087e6d7e68169cdfa718d0e9758952f09f85e163 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# git-permalink
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.
## Usage
```shell
# setup example "remembering" repository
$ git clone git://euandreh.xyz/remembering
$ cd remembering/
```
Now inside the repository folder, running `git permalink` will try build the web URL of the given file use `xdg-open` to launch the browser (or whatever is configured):
```shell
$ git permalink tests/ranking.sh
Opening https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e
$ git permalink tests/ranking.sh 23
Opening https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e#n23
```
Or if you just want to output the link without invoking `xdg-open`, you can use the `-p` flag:
```shell
$ git permalink -p tests/ranking.sh 23
https://git.euandreh.xyz/remembering/tree/tests/ranking.sh?id=44533e2df144e7749a382e298aea53ca11a2239e#n23
```
## Installation
Get the latest tarball and install it:
```shell
wget https://git.euandreh.xyz/git-permalink/snapshot/git-permalink-main.tar.gz
pax -rzf git-permalink-main.tar.gz # or similarly: tar xf git-permalink-main.tar.gz
cd git-permalink-main/
make
[sudo] make install
```
There are no dependencies or requirements, only standard tools such as
`sed`, `mkdir`, etc.
## Documentation
The documentation is available via installed manpages or online: [`git-permalink.1`].
[`git-permalink.1`]: https://euandreh.xyz/git-permalink/git-permalink.1.html
## Contributing
Extratools used for development are:
- [ShellCheck] for validating scripts;
- [pandoc] and Perl for generating the documentation HTML and website.
[ShellCheck]: https://www.shellcheck.net/
[pandoc]: https://pandoc.org/
For running the extra development-only checks, run:
```shell
$ make dev-check
```
and for generating the documentation HTML and website, run:
```shell
$ make public
```
Send contributions to the [mailing list] via [`git send-email`](https://git-send-email.io/).
## Links
- [homepage](https://euandreh.xyz/git-permalink/)
- [source code](https://git.euandreh.xyz/git-permalink/)
- [bug tracking](https://euandreh.xyz/git-permalink/TODOs.html)
- [mailing list]
- [CI logs](https://euandreh.xyz/git-permalink/ci.html)
- [CHANGELOG](https://euandreh.xyz/git-permalink/CHANGELOG.html)
[mailing list]: https://lists.sr.ht/~euandreh/public-inbox?search=%5Bgit-permalink%5D
## Releases
- version [v0.1.0](https://git.euandreh.xyz/git-permalink/snapshot/git-permalink-v0.1.0.tar.gz) ([sig](https://git.euandreh.xyz/git-permalink/snapshot/git-permalink-v0.1.0.tar.gz.asc)), released in 2021-06-13
## License
The code is licensed under [GNU Affero General Public License v3.0 or later][AGPL-3.0-or-later] (AGPL-3.0-or-later).
[AGPL-3.0-or-later]: https://git.euandreh.xyz/git-permalink/tree/COPYING
|
