Repository navigation
SOLR-18509: Port ApiTool to picocli - #5037
Merged
Merged
Conversation
Adds the picocli code path next to the commons-cli one, with a test twin, the generated reference page and test_modules.bats and test_security_manager.bats in the picocli suite.
github-actions
Bot
added
documentation
janhoy
reviewed
Oct 7, 2026
The option text repeated what the command does; the generated page now says what the value is, with an example. The footer example also pointed at GET /api/cluster, which SOLR-18450 removed, so it uses /api/collections.
janhoy
reviewed
Oct 7, 2026
No picocli feature has been released yet, so a new command is a detail of the SOLR-17697 entry. Its author and JIRA are added there instead of a separate entry.
# Conflicts: # changelog/unreleased/SOLR-17697-picocli-experimental-cli.yml # solr/core/src/java/org/apache/solr/cli/SolrCLI.java # solr/packaging/build.gradle # solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc # solr/solr-ref-guide/modules/deployment-guide/pages/cli/index.adoc
dsmiley
pushed a commit
that referenced
this pull request
Oct 9, 2026
Co-authored-by: Jan Høydahl <janhoy@apache.org> (cherry picked from commit 14924e6)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://issues.apache.org/jira/browse/SOLR-18509
Description
Adds the picocli code path for
bin/solr api, next to the commons-cli one.test_modules.batsandtest_security_manager.batscallapi, so they could not join the picocli suite until now.Solution
ApiToolgets its annotated options andcallTool()and is registered inSolrCLI; the commons-cli path is unchanged. Written with Claude Code.Tests
ApiToolPicocliTestruns the existingApiToolTestthrough picocli. Both BATS suites pass under picocli and are added tointegrationTestsPicocli;check -x testis clean (rat skipped).Checklist
mainbranch../gradlew check.