README.md

JabRef Bibliography Management

JabRef is an open-source, cross-platform citation and reference management tool.

Stay on top of your literature: JabRef helps you to collect and organize sources, find the paper you need and discover the latest research.

Features

JabRef is available free of charge and is actively developed. It supports you in every step of your research work.

Collect

• Search across many online scientific catalogues like CiteSeer, CrossRef, Google Scholar, IEEEXplore, INSPIRE-HEP, Medline PubMed, MathSciNet, Springer, arXiv, and zbMATH
• Import options for over 15 reference formats
• Easily retrieve and link full-text articles
• Fetch complete bibliographic information based on ISBN, DOI, PubMed-ID and arXiv-ID
• Extract metadata from PDFs
• Import new references directly from the browser with one click using the official browser extension for Firefox, Chrome, Edge, and Vivaldi

Organize

• Group your research into hierarchical collections and organize research items based on keywords/tags, search terms, or your manual assignments
• Advanced search and filter features
• Complete and fix bibliographic data by comparing with curated online catalogs such as Google Scholar, Springer, or MathSciNet
• Customizable citation key generator
• Customize and add new metadata fields or reference types
• Find and merge duplicates
• Attach related documents: 20 different kinds of documents supported out of the box, completely customizable and extendable
• Automatically rename and move associated documents according to customizable rules
• Keep track of what you read: ranking, priority, printed, quality-assured

Cite

• Native BibTeX and Biblatex support
• Cite-as-you-write functionality for external applications such as Emacs, Kile, LyX, Texmaker, TeXstudio, Vim and WinEdt.
• Format references using one of thousands of built-in citation styles or create your own style
• Support for Word and LibreOffice/OpenOffice for inserting and formatting citations

Share

• Many built-in export options or create your export format
• Library is saved as a simple text file, and thus it is easy to share with others via Dropbox and is version-control friendly
• Work in a team: sync the contents of your library via a SQL database

Installation

Fresh development builds are available at builds.jabref.org. The latest stable release is available at FossHub.

Please see our Installation Guide.

Bug Reports, Suggestions, Other Feedback

We are thankful for any bug reports or other feedback. If you have ideas for new features you want to be included in JabRef, tell us in the feature section of our forum! If you need support in using JabRef, please read the documentation first, the frequently asked questions (FAQ) and also have a look at our community forum. You can use our GitHub issue tracker to file bug reports.

An explanation of donation possibilities and usage of donations is available at our donations page.

Contributing

Want to be part of a free and open-source project that tens of thousands of scientists use every day? Check out the ways you can contribute, below:

• Not a programmer? Help translating JabRef at Crowdin or learn how to help at contribute.jabref.org
• Quick overview on the architecture needed? Look at our high-level documentation
• For details on how to contribute, have a look at our guidelines for contributing.
• You are welcome to contribute new features. To get your code included into JabRef, just fork the JabRef repository, make your changes, and create a pull request.
• To work on existing JabRef issues, check out our issue tracker. New to open source contributing? Look for issues with the "good first issue" label to get started.

We view pull requests as a collaborative process. Submit a pull request early to get feedback from the team on work in progress. We will discuss improvements with you and agree to merge them once the developers approve. Please also remember to discuss bigger changes early with the core developers to avoid a waste of time and work. Some fundamental design decisions can be found within our list of Architectural Decision Records.

If you want a step-by-step walk-through on how to set-up your workspace, please check this guideline.

To compile JabRef from source, you need a Java Development Kit 20 and JAVA_HOME pointing to this JDK. To run it, just execute gradlew run. When you want to develop, it is necessary to generate additional sources using gradlew generateSource and then generate the Eclipse gradlew eclipse. For IntelliJ IDEA, just import the project via a Gradle Import by pointing at the build.gradle.

gradlew test executes all tests. We use GitHub Actions for executing the tests after each commit. For developing, it is sufficient to locally only run the associated test for the classes you changed. Github will report any other failure.

Sponsoring

JabRef development is powered by YourKit Java Profiler