You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .jbang/README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@ This directory contains JBang scripts for JabRef.
6
6
Four use cases:
7
7
8
8
- Runing `JabKit` - JabRef's CLI tool.
9
-
- Runing JabLs - JabRef's Language Server.
10
-
- Runing JabSrv - JabRef's HTTP server.
9
+
- Runing `JabLs` - JabRef's Language Server.
10
+
- Runing `JabSrv` - JabRef's HTTP server.
11
11
- Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.
12
12
13
13
## Running `JabKit`
@@ -54,15 +54,15 @@ Commands:
54
54
>
55
55
>`jbang --fresh jabkit@jabref --help`
56
56
57
-
### Installing and Running JabKit with JBang
57
+
### Installing and Running `JabKit` with JBang
58
58
59
59
To have `jbang` working, you need to [install jbang](https://www.jbang.dev/download/).
60
60
E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`
61
61
62
62
`jbang` also enables to install `jabkit` permanently in your `PATH`:
63
63
64
64
```console
65
-
jbang app install jabkit@jabref
65
+
jbang app install --fresh --force jabkit@jabref
66
66
```
67
67
68
68
Then, you can run JabKit:
@@ -71,9 +71,11 @@ Then, you can run JabKit:
71
71
jabkit --help
72
72
```
73
73
74
-
[JBang takes care about updating JabKit automatically](https://github.com/orgs/jbangdev/discussions/1636#discussioncomment-6150992).
74
+
> [!NOTE]
75
+
> You can use the command above to update JabKit, too.
76
+
> Background: Although [JBang takes care about updating JabKit automatically](https://github.com/orgs/jbangdev/discussions/1636#discussioncomment-6150992), it does not update the `-SNAPSHOT` dependencies.
75
77
76
-
### Running JabKit without installation
78
+
### Running `JabKit` without installation
77
79
78
80
By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit with minimal setup:
79
81
@@ -86,7 +88,7 @@ By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit
86
88
You can also put `gg.cmd` on your `PATH` and make it executable.
87
89
Then you enable`alias jabkit='gg.cmd jbang jabkit@jabref`.
88
90
89
-
## Running JabLs
91
+
## Running `JabLs`
90
92
91
93
In case you have [JBang installed], just run following command:
0 commit comments