JabKit

JabKit is JabRef's CLI tool

Installing and Running

Native binary (recommended)

JabKit is available as a native binary for Linux (amd64/arm64) and macOS (Apple Silicon). It is a self-contained executable: no Java runtime is required, and it starts instantly. Download it from the JabRef builds server and unpack it:

# Linux (amd64)
curl -fL https://builds.jabref.org/main/linux-amd64/tools/jabkit-native_linux.tar.gz | tar xz
./jabkit/jabkit --help

# Linux (arm64)
curl -fL https://builds.jabref.org/main/linux-arm/tools/jabkit-native_linux_arm64.tar.gz | tar xz
./jabkit/jabkit --help

# macOS (Apple Silicon)
curl -fLO https://builds.jabref.org/main/macOS-silicon/tools/jabkit-native_macos-silicon.zip
unzip jabkit-native_macos-silicon.zip
./jabkit/jabkit --help

On other platforms (e.g. Windows, Intel macOS), use one of the options below.

JBang and Docker

The easiest way to run JabKit is using npx and jbang:

npx @jbangdev/jbang jabkit@jabref

You can also run it using docker:

docker run ghcr.io/jabref/jabkit:edge --help

Making JabKit available on the CLI as jabkit

In case JabKit should be available on the command line, execute following steps

1. Install JBang by following one option at the download page of JBang.

2. Execute jbang app install jabkit@jabref

Then, JabKit can be run as follows:

jabkit --help

General Usage

Usage: jabkit [-dhpv] [COMMAND]
  -d, --debug       Enable debug output
  -h, --help        display this help message
  -p, --porcelain   Enable script-friendly output
  -v, --version     display version info

Available Commands

Commands:
  generate-citation-keys  Generate citation keys for entries in a .bib file.
  check-consistency       Check consistency of the library.
  check-integrity         Check integrity of the database.
  fetch                   Fetch entries from a provider.
  search                  Search in a library.
  convert                 Convert between bibliography formats.
  generate-bib-from-aux   Generate small bib from aux file.
  preferences             Manage JabKit preferences.
  pdf                     Manage PDF metadata.
  get-cited-works         Get the cited works (bibliography).
  get-citing-works        Get the works citing the work at hand.

Hint: Using jabkit <COMMAND> --help will show the supported options for each command.

Updating JabKit

Make use of --fresh to update JabKit

jbang --fresh jabkit@jabref

Then, the jabkit command also uses the latest version.