Feature/14361 enable parameters for cli #14500

CodeRishiX · 2025-12-03T04:19:16Z

This draft PR starts adding CLI support for citation key customization.
Work in progress.
I will continue adding the remaining options step-by-step.

Currently, I added the first option:
--pattern: override default citation key pattern (e.g., [auth][year]). Not fully optimized yet.
More CLI options from CitationKeyPatternPreferences will be added next.

Steps to test

:jabkit:run --args="citationkeys generate --input=C:\git-repositories\jabref\jablib\src\main\resources\Chocolate.bib --pattern='[auth][year]'"

No GUI settings are modified — this only affects the current CLI run

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
I added JUnit tests for changes (if applicable)
I added screenshots in the PR description (if change is visible to the user)
I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

calixtus · 2025-12-03T07:59:42Z

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

+    @Option(names = "--output", description = "The output .bib file.")
    private Path outputFile;

+    @Option(


Please implement as a subcommand. We need to keep some hierarchy to keep JabRef and all of its features manageable.

Okay thanks for suggesting .

@calixtus
Thanks again for the guidance. I followed your suggestion and tried to update the hierarchy accordingly. Could you please check if it looks correct now and let me know if I should adjust anything before I continue adding the remaining parts?

calixtus · 2025-12-03T08:01:15Z

README.md

@@ -1,4 +1,4 @@
-# JabRef Bibliography Management [![APIdia](https://apidia.net/java/JabRef/main/badge.svg)](https://apidia.net/java/JabRef/main)
+  # JabRef Bibliography Management [![APIdia](https://apidia.net/java/JabRef/main/badge.svg)](https://apidia.net/java/JabRef/main)


This change seems unrelated to your PR. Please undo.

calixtus · 2025-12-03T08:01:38Z

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

        CitationKeyGenerator keyGenerator = new CitationKeyGenerator(
                databaseContext,
-                argumentProcessor.cliPreferences.getCitationKeyPatternPreferences());
+                prefs);


We do not use abbreviations.

calixtus · 2025-12-03T08:02:03Z

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

            System.out.println(Localization.lang("Regenerating citation keys according to metadata."));
        }

+        var prefs = argumentProcessor.cliPreferences.getCitationKeyPatternPreferences();


We do not use abbreviations.

…ubcommand

koppor · 2025-12-04T11:28:41Z

README.md


 For any inquiries, feel free to [contact ProductMap.ai](https://product-map.ai).
+
+<!-- markdownlint-disable-file MD060 -->


This change seems to be OK - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md060---table-column-style

koppor · 2025-12-04T11:29:11Z

jabkit/src/main/java/org/jabref/toolkit/commands/CitationKeyCommands.java

+
+@Command(
+        name = "citationkeys",
+        description = "Manage citation key operations.",


I think, this is not a good text. Maybe just remove it.

koppor · 2025-12-04T11:30:10Z

test.bib

@@ -0,0 +1,12 @@
+@article{dummy,


Please use src/main/resources/Chocolate.bib instead of putting a .bib file in the root of the repository.

…est.bib, undo README changes

CodeRishiX · 2025-12-06T16:58:38Z

@koppor @calixtus Fixed all review comments as suggested - removed CitationKeyCommands description, deleted test.bib, and resolved README changes.

koppor

Some comments; I don't know What is left todo - the PR is flagged as "draft"

jabkit/src/main/java/org/jabref/toolkit/commands/CitationKeyCommands.java

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

koppor · 2025-12-07T22:45:07Z

Not fully optimized yet.

Please work on this. See the screenshot at #14361.

…escription.

…egex, delimiter, etc.)

CodeRishiX · 2025-12-12T17:03:48Z

@calixtus @koppor
Hi!
I’ve implemented all parameters of CitationKeyPatternPreferences in the CLI except the per-entry-type patterns.

CitationKeyPatternPreferences supports type-specific patterns , but JabKit’s GlobalCitationKeyPatterns currently applies only a single default pattern and does not support per-entry-type overrides.

public class GlobalCitationKeyPatterns extends AbstractCitationKeyPatterns {

public GlobalCitationKeyPatterns(CitationKeyPattern defaultPattern) {
    this.defaultPattern = defaultPattern;
}

public static GlobalCitationKeyPatterns fromPattern(String pattern) {
    return new GlobalCitationKeyPatterns(new CitationKeyPattern(pattern));
}

@Override
public CitationKeyPattern getLastLevelCitationKeyPattern(EntryType entryType) {
    return defaultPattern;
}

Because of this mismatch, I’ve kept keyPatterns unchanged for now until your guidance.

Thanks!

CodeRishiX added 2 commits December 3, 2025 09:17

add --pattern option support for citation key generation

4fe7d9d

(cli): add --pattern option support for citation key generation

13d4136

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 3, 2025

calixtus reviewed Dec 3, 2025

View reviewed changes

JabKit: add citationkeys command and move generate-citation-keys as s…

ae07309

…ubcommand

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 4, 2025

koppor reviewed Dec 4, 2025

View reviewed changes

koppor added the status: changes-required Pull requests that are not yet complete label Dec 4, 2025

CodeRishiX added 2 commits December 6, 2025 22:09

Fix review comments: remove CitationKeyCommands description, delete t…

d04412e

…est.bib, undo README changes

Merge branch 'main' into feature/14361-enable-parameters-for-cli

ba378e4

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 6, 2025

koppor requested changes Dec 7, 2025

View reviewed changes

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 7, 2025

Fix code style: remove var keyword, rename pattern variable, update d…

a8aa88d

…escription.

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 9, 2025

Merge branch 'main' into feature/14361-enable-parameters-for-cli

95fac71

calixtus added component: JabKit [cli] component: citationkey-generator labels Dec 12, 2025

CodeRishiX added 2 commits December 12, 2025 22:11

Add citation key generation options to JabKit CLI (pattern, suffix, r…

aadb52c

…egex, delimiter, etc.)

Add citation key generation options to JabKit CLI (pattern, suffix, r…

0370046

…egex, delimiter, etc.)

Merge branch 'main' into feature/14361-enable-parameters-for-cli

477f3f6

		@@ -1,4 +1,4 @@
		# JabRef Bibliography Management [![APIdia](https://apidia.net/java/JabRef/main/badge.svg)](https://apidia.net/java/JabRef/main)
		# JabRef Bibliography Management [![APIdia](https://apidia.net/java/JabRef/main/badge.svg)](https://apidia.net/java/JabRef/main)


		For any inquiries, feel free to [contact ProductMap.ai](https://product-map.ai).

		<!-- markdownlint-disable-file MD060 -->

Uh oh!

Feature/14361 enable parameters for cli #14500

Are you sure you want to change the base?

Feature/14361 enable parameters for cli #14500

Conversation

CodeRishiX commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CodeRishiX commented Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koppor commented Dec 7, 2025

Uh oh!

CodeRishiX commented Dec 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CodeRishiX commented Dec 3, 2025 •

edited

Loading

CodeRishiX commented Dec 6, 2025 •

edited

Loading