Skip to content

Document JabKit native binary as recommended install method#644

Open
koppor wants to merge 2 commits into
mainfrom
jabkit-native-install
Open

Document JabKit native binary as recommended install method#644
koppor wants to merge 2 commits into
mainfrom
jabkit-native-install

Conversation

@koppor

@koppor koppor commented Jul 20, 2026

Copy link
Copy Markdown
Member

Documents the native JabKit binary introduced by JabRef/jabref#16291 as the recommended way to install JabKit (Linux amd64/arm64, macOS Apple Silicon), keeping JBang/Docker for the remaining platforms.

Low-risk documentation update — should be quick to review and merge. Please merge only after JabRef/jabref#16291 is merged, since the download URLs exist only from then on.

🤖 Generated with Claude Code

Follows JabRef/jabref#16291, which ships jabkit as a GraalVM native
binary in the binary distribution.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GECSiMgNPPrrFmqCSixkcs
Comment thread en/jabkit.md
```bash
# Linux (amd64)
curl -L https://builds.jabref.org/main/linux-amd64/tools/jabkit-native_linux.tar.gz | tar xz
./jabkit/jabkit --help

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no chmod+x needed?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's un-tar.d - and tar keeps executable flags

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't let AI speak for you :-P

@koppor koppor Jul 20, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Generated with Claude Code

(generatd by Claude)

You are right that the command as written cannot work today — the main URLs only come into existence once JabRef/jabref#16291 is merged and a main build has run (hence the note in the PR description to merge this only after that PR). What you downloaded was the builds-server HTML error page saved as a .zip. Two follow-ups:

  1. The docs now use curl -f (commit e1acc8b), so a missing file fails with curl: (22) The requested URL returned error: 404 instead of silently saving an HTML page.
  2. I labeled jabref#16291 with dev: binaries so its artifacts got uploaded, and ran the documented commands against the PR build (same commands, pull-16291 in place of main):
$ curl -fL https://builds.jabref.org/pull-16291/linux-amd64/tools/jabkit-native_linux.tar.gz | tar xz
$ ls -l jabkit/jabkit
-rwxr-xr-x 1 koppor koppor 131729672 jabkit        # exec bit preserved, no chmod needed
$ ./jabkit/jabkit -p check consistency test.bib; echo $?
0
$ curl -fLO https://builds.jabref.org/pull-16291/macOS-silicon/tools/jabkit-native_macos-silicon.zip
$ unzip jabkit-native_macos-silicon.zip && ls -l jabkit/jabkit && file jabkit/jabkit
-rwxr-xr-x 1 koppor koppor 147558936 jabkit
jabkit/jabkit: Mach-O 64-bit arm64 executable

So archive layout (jabkit/jabkit at the root), executable bit, and the binary itself all work as documented once the artifacts exist. If you want to try it on your Mac before the merge, the pull-16291 URL above is live now.

Comment thread en/jabkit.md
```bash
# macOS (Apple Silicon)
curl -LO https://builds.jabref.org/main/macOS-silicon/tools/jabkit-native_macos-silicon.zip
unzip jabkit-native_macos-silicon.zip

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like you did not try it.

``
curl -LO https://builds.jabref.org/main/macOS-silicon/tools/jabkit-native_macos-silicon.zip
gives me a 3kb zip file which is an invalid zip file. I change extnesion to HTML and it loolks like this

Image

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not in main yet - because we are in the PR JabRef/jabref#16291

@koppor

koppor commented Jul 20, 2026

Copy link
Copy Markdown
Member Author

🤖 Generated with Claude Code

How to test these instructions before JabRef/jabref#16291 is merged:

The native binaries from the JabRef PR build are available at https://builds.jabref.org/pull-16291/ (uploaded via the dev: binaries label). Use the documented commands with pull-16291 in place of main:

# Linux (amd64)
curl -fL https://builds.jabref.org/pull-16291/linux-amd64/tools/jabkit-native_linux.tar.gz | tar xz
./jabkit/jabkit --help
# Linux (arm64)
curl -fL https://builds.jabref.org/pull-16291/linux-arm/tools/jabkit-native_linux_arm64.tar.gz | tar xz
./jabkit/jabkit --help
# macOS (Apple Silicon)
curl -fLO https://builds.jabref.org/pull-16291/macOS-silicon/tools/jabkit-native_macos-silicon.zip
unzip jabkit-native_macos-silicon.zip
./jabkit/jabkit --help

After JabRef/jabref#16291 is merged and a main build has run, the main URLs used in this documentation become live and this PR can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants