Skip to content

Document jabkit pdf extract-references command #641

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

Open
koppor wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document jabkit pdf extract-references command #641

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2644e0b
Document jabkit pdf extract-references command
koppor Jul 6, 2026
0e34435
Merge branch 'main' into jabkit-extract-references-docs
Siedlerchr Jul 20, 2026
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
19 changes: 19 additions & 0 deletions en/jabkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,25 @@

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

## Extracting References from a PDF

`jabkit pdf extract-references` parses the "References" section at the end of one or more PDFs and outputs the found entries as BibTeX — the same extraction the JabRef GUI offers via the "Extract references" right-click action on a linked PDF.

```bash
# single PDF, BibTeX printed to stdout
jabkit pdf extract-references paper.pdf

# multiple PDFs, one .bib file written next to each source PDF
jabkit pdf extract-references paper1.pdf paper2.pdf

# write into a specific directory instead
jabkit pdf extract-references --output-dir out/ paper1.pdf paper2.pdf
```

Use `--mode` to choose the extraction strategy: `RULE_BASED` (offline, no external service), `GROBID` (sends the PDF to a [Grobid](https://grobid.readthedocs.io/) server; `--grobid-url` overrides the configured server for a single call), or `LLM` (experimental, uses the configured AI provider). Without `--mode`, the command mirrors the GUI's behavior and picks `GROBID` if it is enabled in your preferences, otherwise `RULE_BASED`.

Check warning on line 78 in en/jabkit.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "en/jabkit.md", "range": {"start": {"line": 78, "column": 379}}}, "severity": "WARNING"}

Check warning on line 78 in en/jabkit.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.TooWordy] 'it is' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "en/jabkit.md", "range": {"start": {"line": 78, "column": 376}}}, "severity": "WARNING"}

See `jabkit pdf extract-references --help` for all options.

## Updating JabKit

Make use of `--fresh` to update JabKit
Expand Down
Loading