Skip to content

Commit 062c905

Browse files
kopporsubhramit
andauthored
Add .jbang/README.md (#13437)
* Add .jbang/README.md * Apply suggestions from code review Co-authored-by: Subhramit Basu <subhramit.bb@live.in> --------- Co-authored-by: Subhramit Basu <subhramit.bb@live.in>
1 parent bc3dcfa commit 062c905

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.jbang/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# JBang scripts for JabRef
2+
3+
This directory contains [JBang](https://www.jbang.dev/) scripts for JabRef.
4+
5+
Three use cases:
6+
7+
- Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.
8+
- Run `JabKit` - JabRef's CLI tool.
9+
- Run `JabSrv` - JabRef's HTTP server.
10+
11+
## Running `JabKit`
12+
13+
If you have JBang installed, just run `jbang jabkit@jabref --help`
14+
15+
If not, download [`gg.cmd`](https://github.com/eirikb/gg/tree/main?tab=readme-ov-file#ggcmd), place it in the current directory (or on your `PATH`) and execute:
16+
17+
gg.cmd jbang jabkit@jabref --help
18+
19+
## Running `JabSrv`
20+
21+
If you have JBang installed, just run `jbang jabsrv@jabref --help`
22+
23+
With `gg.cmd`:
24+
25+
gg.cmd jbang jabsrv@jabref --help
26+

0 commit comments

Comments
 (0)