Skip to content

Add --fresh parameter to JBang readme #14429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 28, 2025
+10 −8
Merged

Add --fresh parameter to JBang readme #14429

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ce8468b
Add `--fresh` parameter
koppor Nov 25, 2025
06203c5
Fix casing
koppor Nov 25, 2025
351bdea
Fix another typo
koppor Nov 25, 2025
fb5b33a
Fix casing
koppor Nov 28, 2025
5f989a9
Improve formatting
koppor Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions .jbang/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This directory contains JBang scripts for JabRef.
Four use cases:

- Runing `JabKit` - JabRef's CLI tool.
- Runing JabLs - JabRef's Language Server.
- Runing JabSrv - JabRef's HTTP server.
- Runing `JabLs` - JabRef's Language Server.
- Runing `JabSrv` - JabRef's HTTP server.
- Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.

## Running `JabKit`
Expand Down Expand Up @@ -54,15 +54,15 @@ Commands:
>
> `jbang --fresh jabkit@jabref --help`

### Installing and Running JabKit with JBang
### Installing and Running `JabKit` with JBang

To have `jbang` working, you need to [install jbang](https://www.jbang.dev/download/).
E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`

`jbang` also enables to install `jabkit` permanently in your `PATH`:

```console
jbang app install jabkit@jabref
jbang app install --fresh --force jabkit@jabref
```

Then, you can run JabKit:
Expand All @@ -71,9 +71,11 @@ Then, you can run JabKit:
jabkit --help
```

[JBang takes care about updating JabKit automatically](https://github.com/orgs/jbangdev/discussions/1636#discussioncomment-6150992).
> [!NOTE]
> You can use the command above to update JabKit, too.
> 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.

### Running JabKit without installation
### Running `JabKit` without installation

By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit with minimal setup:

Expand All @@ -86,7 +88,7 @@ By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit
You can also put `gg.cmd` on your `PATH` and make it executable.
Then you enable `alias jabkit='gg.cmd jbang jabkit@jabref`.

## Running JabLs
## Running `JabLs`

In case you have [JBang installed], just run following command:

Expand All @@ -108,7 +110,7 @@ npx @jbangdev/jbang jabls@jabref

One can add `--help` to see available options.

## Running JabSrv
## Running `JabSrv`

In case you have [JBang installed], just run following command:

Expand Down