Skip to content

Commit fc8a1c0

Browse files
kopporshubhamk0205
authored andcommitted
Add --fresh parameter to JBang readme (JabRef#14429)
* Add `--fresh` parameter * Fix casing * Fix another typo * Fix casing * Improve formatting
1 parent 64ef0ba commit fc8a1c0

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

.jbang/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This directory contains JBang scripts for JabRef.
66
Four use cases:
77

88
- 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.
1111
- Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.
1212

1313
## Running `JabKit`
@@ -54,15 +54,15 @@ Commands:
5454
>
5555
> `jbang --fresh jabkit@jabref --help`
5656
57-
### Installing and Running JabKit with JBang
57+
### Installing and Running `JabKit` with JBang
5858
5959
To have `jbang` working, you need to [install jbang](https://www.jbang.dev/download/).
6060
E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`
6161
6262
`jbang` also enables to install `jabkit` permanently in your `PATH`:
6363
6464
```console
65-
jbang app install jabkit@jabref
65+
jbang app install --fresh --force jabkit@jabref
6666
```
6767
6868
Then, you can run JabKit:
@@ -71,9 +71,11 @@ Then, you can run JabKit:
7171
jabkit --help
7272
```
7373
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.
7577
76-
### Running JabKit without installation
78+
### Running `JabKit` without installation
7779
7880
By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit with minimal setup:
7981
@@ -86,7 +88,7 @@ By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit
8688
You can also put `gg.cmd` on your `PATH` and make it executable.
8789
Then you enable `alias jabkit='gg.cmd jbang jabkit@jabref`.
8890
89-
## Running JabLs
91+
## Running `JabLs`
9092
9193
In case you have [JBang installed], just run following command:
9294
@@ -108,7 +110,7 @@ npx @jbangdev/jbang jabls@jabref
108110
109111
One can add `--help` to see available options.
110112
111-
## Running JabSrv
113+
## Running `JabSrv`
112114
113115
In case you have [JBang installed], just run following command:
114116

0 commit comments

Comments
 (0)