diff --git a/.github/workflows/bin-solr-test.yml b/.github/workflows/bin-solr-test.yml index d4d7594f5e47..23b4582d017e 100644 --- a/.github/workflows/bin-solr-test.yml +++ b/.github/workflows/bin-solr-test.yml @@ -30,8 +30,7 @@ jobs: - name: Test the bin/solr script run: ./gradlew integrationTests - # Reuses the distribution built above, so this only costs the curated suite run. - - name: Test the bin/solr script with the experimental picocli CLI + - name: Test the bin/solr script with PicoCLI run: ./gradlew integrationTestsPicocli - name: Archive logs diff --git a/changelog/unreleased/SOLR-17697-picocli-experimental-cli.yml b/changelog/unreleased/SOLR-17697-migrate-cli-to-picocli.yml similarity index 75% rename from changelog/unreleased/SOLR-17697-picocli-experimental-cli.yml rename to changelog/unreleased/SOLR-17697-migrate-cli-to-picocli.yml index 2c102eb62aca..93c88f99213a 100644 --- a/changelog/unreleased/SOLR-17697-picocli-experimental-cli.yml +++ b/changelog/unreleased/SOLR-17697-migrate-cli-to-picocli.yml @@ -1,8 +1,7 @@ title: > - An experimental re-implementation of the `bin/solr` command line interface, built on picocli, - is now included. It is disabled by default and is enabled with `SOLR_PICOCLI=true`. Only some - commands have been migrated so far, and its options may change between releases. See the - "Experimental picocli Command Line Interface" page in the Reference Guide. + Migration of the `bin/solr` command line interface, to picocli. + It is enabled by default and can be disabled with `SOLR_PICOCLI=false`. See the + "PicoCLI Command Line Interface" page in the Reference Guide. type: added authors: - name: Jan Høydahl @@ -10,6 +9,7 @@ authors: - name: Serhiy Bzhezytskyy - name: Jalaz Kumar nick: jaykay12 + - name: Eric Pugh links: - name: SOLR-17697 url: https://issues.apache.org/jira/browse/SOLR-17697 @@ -35,3 +35,5 @@ links: url: https://issues.apache.org/jira/browse/SOLR-18517 - name: SOLR-18515 url: https://issues.apache.org/jira/browse/SOLR-18515 + - name: SOLR-18561 + url: https://issues.apache.org/jira/browse/SOLR-18561 diff --git a/dev-docs/ref-guide/antora.adoc b/dev-docs/ref-guide/antora.adoc index 15002a4e6b83..1f21a51b8878 100644 --- a/dev-docs/ref-guide/antora.adoc +++ b/dev-docs/ref-guide/antora.adoc @@ -86,17 +86,6 @@ The new command will automatically appear in the generated pages, in the navigat `pages/cli/index.adoc` is the only hand-written page in that directory; everything matching `solr-*.adoc` is generated and must not be edited by hand. `solr-control-script-reference.adoc` documents the default (commons-cli) implementation and should not gain per-command links to the generated pages while the picocli implementation is experimental. -=== What a tool migration should include - -When migrating a tool to picocli: - -* A `*PicocliTest` subclass of the tool's existing test that overrides only the invocation strategy, so every case runs on both implementations. See `ZkSubcommandsPicocliTest` for the pattern. -* The tool's `.bats` file added to `integrationTestsPicocli` in `solr/packaging/build.gradle`, but only once *every* command that suite invokes has been migrated, not just the one under test. - `test_auth.bats`, for example, uses `solr assert` to wait for startup, so it cannot be added until the assert command is migrated. - Be aware that a failure part-way through that suite is especially awkward: `solr auth enable` appends `SOLR_AUTH_TYPE` and `SOLR_AUTHENTICATION_OPTS` to the `solr.in.sh` of the *built distribution* under `solr/packaging/build/`, so an aborted run leaves every later `bin/solr` invocation trying to authenticate. - If BATS runs start hanging for no apparent reason, check that file, and delete the distribution directory to force `installFullDist` to recreate it. -* A `gradlew :solr:solr-ref-guide:generateCliDocs` run, with the result committed. -* The tool registered in `SolrCLI`'s `subcommands` only once `callTool()` actually works; `SolrCLIPicocliTest` enforces the rules that apply to every registered command. == Building the HTML Site diff --git a/solr/bin/solr b/solr/bin/solr index db487c04bfd2..f77e1295f2a9 100755 --- a/solr/bin/solr +++ b/solr/bin/solr @@ -828,10 +828,10 @@ if [ $# -gt 0 ]; then shift 2 ;; -h|--help) - if [[ "${SOLR_PICOCLI:-}" == "true" ]]; then - run_tool "$SCRIPT_CMD" --help + if [[ "${SOLR_PICOCLI:-}" == "false" ]]; then + print_usage "$SCRIPT_CMD" else - print_usage "$SCRIPT_CMD" + run_tool "$SCRIPT_CMD" --help fi exit 0 ;; diff --git a/solr/bin/solr.cmd b/solr/bin/solr.cmd index 3867aa1049b7..1adde3d449d0 100755 --- a/solr/bin/solr.cmd +++ b/solr/bin/solr.cmd @@ -422,8 +422,8 @@ IF "%1"=="-h" goto check_picocli_help goto after_help_check :check_picocli_help -IF "%SOLR_PICOCLI%"=="true" goto run_picocli_help -goto usage +IF "%SOLR_PICOCLI%"=="false" goto usage +goto run_picocli_help :run_picocli_help "%JAVA%" %SOLR_SSL_OPTS% %AUTHC_OPTS% %SOLR_ZK_CREDS_AND_ACLS% %SOLR_TOOL_OPTS% -Dsolr.install.dir="%SOLR_TIP%" ^ diff --git a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java index 555b30bf7c8d..82a7973b1ee0 100755 --- a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java +++ b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java @@ -139,7 +139,7 @@ public static void exit(int exitStatus) { /** Runs a tool. */ public static void main(String[] args) throws Exception { - if (EnvUtils.getPropertyAsBool("solr.picocli", false)) { + if (EnvUtils.getPropertyAsBool("solr.picocli", true)) { SSLConfigurationsFactory.current().init(); picocli.CommandLine commandLine = new picocli.CommandLine(new SolrCLI()); propagateCommandSettings(commandLine); diff --git a/solr/packaging/build.gradle b/solr/packaging/build.gradle index dedb2783018c..14bfde2b5509 100644 --- a/solr/packaging/build.gradle +++ b/solr/packaging/build.gradle @@ -338,26 +338,38 @@ def configureBatsTask(BatsTask task, String outputName, boolean usePicocli) { task.environment TEST_OUTPUT_DIR: integrationTestOutput task.environment TEST_FAILURE_DIR: solrTestFailuresDir task.environment BATS_LIB_PREFIX: batsLibsDir - if (usePicocli) { - task.environment SOLR_PICOCLI: 'true' + if (!usePicocli) { + task.environment SOLR_PICOCLI: 'false' } } +// TODO: Remove this when cleaning up commons-cli task integrationTests(type: BatsTask) { + description = 'Runs the BATS suites for the CLI powered by commons-cli.' configureBatsTask(it, 'test-output', false) } -// The same suites run against the experimental picocli CLI. Deliberately a curated list rather -// than the whole suite, so the run stays short. A change that ports another tool to picocli -// should add that tool's .bats file here. +// The same suites run against the picocli CLI. task integrationTestsPicocli(type: BatsTask) { - description = 'Runs the BATS suites for the migrated commands against the experimental picocli CLI.' + description = 'Runs the BATS suites for the CLI powered by PicoCLI.' configureBatsTask(it, 'test-output-picocli', true) - // A suite belongs here only when every command it invokes has been migrated, not merely the - // command under test. test_auth.bats, for example, uses `solr assert` to wait for startup, so - // it cannot join until the assert command is migrated. test_help.bats asserts the exact wording - // of the commons-cli help output, which the picocli implementation words differently. + // TODO: Remove these explicit files entry from here after fixing 4 remaining bats file testFiles = [ + 'test/test_adminconsole_urls.bats', + 'test/test_assert.bats', + 'test/test_bats.bats', + 'test/test_compression.bats', + 'test/test_config.bats', + 'test/test_create_collection.bats', + 'test/test_example.bats', + 'test/test_export.bats', + 'test/test_opennlp.bats', + 'test/test_placement_plugin.bats', + 'test/test_rolling_upgrade.bats', + 'test/test_snapshots.bats', + 'test/test_ssl.bats', + 'test/test_start_solr.bats', + 'test/test_zz_cleanup.bats', 'test/test_version.bats', 'test/test_status.bats', 'test/test_create.bats', diff --git a/solr/solr-ref-guide/build.gradle b/solr/solr-ref-guide/build.gradle index c84ce7c4b106..06df775b62d8 100644 --- a/solr/solr-ref-guide/build.gradle +++ b/solr/solr-ref-guide/build.gradle @@ -15,9 +15,9 @@ * limitations under the License. */ + import groovy.json.JsonOutput import javax.inject.Inject -import org.gradle.process.ExecOperations import org.apache.tools.ant.util.TeeOutputStream apply plugin: 'java' @@ -592,15 +592,6 @@ def ASF_LICENSE_HEADER = """\ // under the License. """ -def EXPERIMENTAL_NOTICE = """\ -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== -""" - def DO_NOT_EDIT_NOTICE = """\ // // DO NOT EDIT -- this page is auto-generated from picocli annotations. @@ -719,7 +710,7 @@ String markRequiredOptionsAndArgs(String content) { // Post-process a raw ManPageGenerator AsciiDoc file for Antora compatibility. // The title lives inside the man-section-header block, so we replace the whole // header block with an Antora-compatible page title + attributes. -String postProcessCliManPage(File rawFile, Set stems, String asfHeader, String doNotEditNotice, String experimentalNotice) { +String postProcessCliManPage(File rawFile, Set stems, String asfHeader, String doNotEditNotice) { def content = rawFile.text def baseName = rawFile.name.replace('.adoc', '') def newTitle = cliFileNameToTitle(baseName, stems) @@ -775,7 +766,7 @@ String postProcessCliManPage(File rawFile, Set stems, String asfHeader, String d // Inserted last, after the blanket 'xref:solr-' -> 'xref:cli/solr-' rewrite above, which would // otherwise redirect this notice's own link into pages/cli/. - content = content.replace(":page-toclevels: 2\n", ":page-toclevels: 2\n\n" + experimentalNotice) + content = content.replace(":page-toclevels: 2\n", ":page-toclevels: 2\n\n") return asfHeader + doNotEditNotice + "\n" + content.stripTrailing() + "\n" } @@ -862,7 +853,7 @@ task generateCliDocs { def stems = rawFiles.collect { it.name.replace('.adoc', '') } as Set rawFiles.each { rawFile -> - def processed = postProcessCliManPage(rawFile, stems, ASF_LICENSE_HEADER, DO_NOT_EDIT_NOTICE, EXPERIMENTAL_NOTICE) + def processed = postProcessCliManPage(rawFile, stems, ASF_LICENSE_HEADER, DO_NOT_EDIT_NOTICE) new File(destDir, rawFile.name).text = processed } @@ -919,7 +910,7 @@ task checkCliDocsUpToDate { def issues = [] rawFiles.each { rawFile -> - def processed = postProcessCliManPage(rawFile, stems, ASF_LICENSE_HEADER, DO_NOT_EDIT_NOTICE, EXPERIMENTAL_NOTICE) + def processed = postProcessCliManPage(rawFile, stems, ASF_LICENSE_HEADER, DO_NOT_EDIT_NOTICE) def committed = new File(committedDir, rawFile.name) if (!committed.exists()) { issues << "MISSING committed file (new command): ${rawFile.name}" diff --git a/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc b/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc index e22a51c7be1e..3613da472d1f 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc @@ -18,7 +18,7 @@ .Deployment Guide * xref:solr-control-script-reference.adoc[] -** xref:cli/index.adoc[Experimental picocli CLI] +** xref:cli/index.adoc[CLI command reference] // CLI-DOCS-START *** xref:cli/solr-api.adoc[api] *** xref:cli/solr-assert.adoc[assert] diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/index.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/index.adoc index fb8ea48e30eb..1e232f544e14 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/index.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/index.adoc @@ -1,4 +1,4 @@ -= Experimental picocli Command Line Interface += Command Line Interface :page-toclevels: 2 // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file @@ -17,42 +17,34 @@ // specific language governing permissions and limitations // under the License. -Solr is migrating the `bin/solr` command line tool from Apache Commons CLI to https://picocli.info/[picocli]. -While that work is in progress, both implementations ship together and the picocli one can be enabled on request. +The `bin/solr` command line tool is built on https://picocli.info/[picocli]. +This page and the per-command pages linked below are the references for its commands and options. +Run `bin/solr --help` for the same information on the command line. -[WARNING] -==== -The picocli command line interface is *experimental* and disabled by default. +== Falling back to the legacy CLI -* Only some commands have been migrated so far. -* Options, defaults and error messages may change without notice between releases. -* Where this implementation and the default one differ, xref:solr-control-script-reference.adoc[] describes what `bin/solr` actually does by default. +The previous Apache Commons CLI implementation still ships with Solr. +Use it only as an escape hatch if you run into a problem with the default CLI, and please report the problem to the Solr project. +Its options and output differ in places; see xref:solr-control-script-reference.adoc[] for its documentation. -Do not depend on it in scripts or automation yet. -==== - -== Enabling It - -Set `SOLR_PICOCLI` in your `solr.in.sh` (or `solr.in.cmd` on Windows): +To switch, set `SOLR_PICOCLI` in your `solr.in.sh` (or `solr.in.cmd` on Windows): [source,bash] ---- -SOLR_PICOCLI=true +SOLR_PICOCLI=false ---- Or set the equivalent system property for a single invocation: [source,bash] ---- -SOLR_TOOL_OPTS="-Dsolr.picocli=true" bin/solr status +SOLR_TOOL_OPTS="-Dsolr.picocli=false" bin/solr status ---- -Unset it, or set it to anything other than `true`, to return to the default implementation. -== Migrated Commands +== Commands -The commands below have been migrated and have a reference page generated from their source annotations. -Any command not listed here is unavailable when the picocli implementation is enabled, and reports an unmatched argument. +Each command has a reference page generated from its source annotations. // CLI-DOCS-TABLE-START [cols="1",options="header"] @@ -103,18 +95,18 @@ Any command not listed here is unavailable when the picocli implementation is en |=== // CLI-DOCS-TABLE-END -== Known Limitations +== Migration Changes -In addition to the commands that have not been migrated yet: +These are the changes in default CLI behavior as compared to 9.x and 10.1. * On a sub-command, `-v` means `--verbose`; only the top-level `bin/solr` accepts `-v` as a request for the version. * `bin/solr config` has no `-v` short form for `--value`, because `-v` means `--verbose`; use `--value`. - The default implementation accepts `-v` for it. + The legacy CLI accepts `-v` for it. * `--fail-on-exists` on `bin/solr zk mkroot` treats the option as set whenever it is present, whatever value follows it. - This matches the default implementation, but means `--fail-on-exists false` does not disable the check. -* Error messages for invalid or mutually exclusive options are worded differently from the default implementation. + This matches the legacy CLI, but means `--fail-on-exists false` does not disable the check. +* Error messages for invalid or mutually exclusive options are worded differently from the legacy CLI. * Usage and help output is laid out differently throughout, so anything parsing the output of `--help` will need adjusting. -* Typing a `zk` sub-command without the `zk` prefix, for example `bin/solr ls`, reports an unmatched argument rather than the reminder the default implementation prints. +* Typing a `zk` sub-command without the `zk` prefix, for example `bin/solr ls`, reports an unmatched argument rather than the reminder the legacy CLI prints. That syntax was removed in Solr 9; use `bin/solr zk ls`. == Reporting Problems diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-api.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-api.adoc index cccb38dc9e95..7b133ca1275d 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-api.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-api.adoc @@ -22,12 +22,6 @@ = bin/solr api :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-assert.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-assert.adoc index 39c13bf82063..6261be663d1b 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-assert.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-assert.adoc @@ -22,12 +22,6 @@ = bin/solr assert :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-auth.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-auth.adoc index 31a64352cf57..e5878df1bdf4 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-auth.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-auth.adoc @@ -22,12 +22,6 @@ = bin/solr auth :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-cluster.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-cluster.adoc index cd4c7ee8792b..7cf7e7ffe0f1 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-cluster.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-cluster.adoc @@ -22,12 +22,6 @@ = bin/solr cluster :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-config.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-config.adoc index d598219ae76d..dd74fe1c5e8d 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-config.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-config.adoc @@ -22,12 +22,6 @@ = bin/solr config :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc index a584a9c55656..90d2cad04fac 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc @@ -22,12 +22,6 @@ = bin/solr create :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc index 8ee0fa65e14a..ec5d9640ce70 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc @@ -22,12 +22,6 @@ = bin/solr delete :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-export.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-export.adoc index 74d126d3943f..66d1bbfb474a 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-export.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-export.adoc @@ -22,12 +22,6 @@ = bin/solr export :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-healthcheck.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-healthcheck.adoc index 15365fde2fce..a2c886e9822b 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-healthcheck.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-healthcheck.adoc @@ -22,12 +22,6 @@ = bin/solr healthcheck :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-key.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-key.adoc index d3627e3b9707..ef84b52e28d8 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-key.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-key.adoc @@ -22,12 +22,6 @@ = bin/solr package add-key :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-repo.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-repo.adoc index 23fdc5e602fe..a5a15d844115 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-repo.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-add-repo.adoc @@ -22,12 +22,6 @@ = bin/solr package add-repo :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-deploy.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-deploy.adoc index cd1b181a2a41..31e6ba15a03f 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-deploy.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-deploy.adoc @@ -22,12 +22,6 @@ = bin/solr package deploy :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-install.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-install.adoc index 7734cedff149..597a690c1f09 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-install.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-install.adoc @@ -22,12 +22,6 @@ = bin/solr package install :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-available.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-available.adoc index 2f3aa96e0e54..6b69d9ce4023 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-available.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-available.adoc @@ -22,12 +22,6 @@ = bin/solr package list-available :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-deployed.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-deployed.adoc index 988f0e0768bd..88fa0bc4dd8a 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-deployed.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-deployed.adoc @@ -22,12 +22,6 @@ = bin/solr package list-deployed :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-installed.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-installed.adoc index f57b076cc222..71370549dcda 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-installed.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-list-installed.adoc @@ -22,12 +22,6 @@ = bin/solr package list-installed :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-undeploy.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-undeploy.adoc index dd61fbb36a0d..a45d356e5737 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-undeploy.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-undeploy.adoc @@ -22,12 +22,6 @@ = bin/solr package undeploy :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-uninstall.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-uninstall.adoc index 689984fa85ac..79ba6db6e1ae 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-uninstall.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package-uninstall.adoc @@ -22,12 +22,6 @@ = bin/solr package uninstall :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package.adoc index ba00cf3e03b3..634d6efc8c17 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-package.adoc @@ -22,12 +22,6 @@ = bin/solr package :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-post.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-post.adoc index df98377f08fc..6c408ad24e3d 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-post.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-post.adoc @@ -22,12 +22,6 @@ = bin/solr post :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-postlogs.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-postlogs.adoc index 61c4a1a94cd7..d32280315f93 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-postlogs.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-postlogs.adoc @@ -22,12 +22,6 @@ = bin/solr postlogs :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-create.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-create.adoc index e4b1b14c008d..ab4d5946bfcc 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-create.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-create.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot create :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-delete.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-delete.adoc index eadf9e84b7c4..614e3670ca51 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-delete.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-delete.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot delete :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-describe.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-describe.adoc index 11e6a1a31ce0..5e132595a394 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-describe.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-describe.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot describe :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-export.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-export.adoc index 606617e3f3c6..e623818dd394 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-export.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-export.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot export :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-list.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-list.adoc index d0139e4520aa..a40e5e098929 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-list.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot-list.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot list :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot.adoc index f0b674d06788..32dd76de3132 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-snapshot.adoc @@ -22,12 +22,6 @@ = bin/solr snapshot :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-start.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-start.adoc index a6ba0f61c2bb..0edd47577e09 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-start.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-start.adoc @@ -22,12 +22,6 @@ = bin/solr start :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc index 506af27a78a9..c463c593b730 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc @@ -22,12 +22,6 @@ = bin/solr status :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stop.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stop.adoc index f50fda6aebe9..19451d2e291b 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stop.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stop.adoc @@ -22,12 +22,6 @@ = bin/solr stop :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stream.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stream.adoc index e62f5b1a1bb8..290ea3d73847 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stream.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-stream.adoc @@ -22,12 +22,6 @@ = bin/solr stream :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-version.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-version.adoc index 05caaf3eab6a..396a50752fe6 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-version.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-version.adoc @@ -22,12 +22,6 @@ = bin/solr version :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc index 49ecf2a0b652..8466e00aa4d7 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc @@ -22,12 +22,6 @@ = bin/solr zk cp :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc index 90710607ed78..1dee81d2b053 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc @@ -22,12 +22,6 @@ = bin/solr zk downconfig :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc index 7c917b401543..152ed0d28f3f 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc @@ -22,12 +22,6 @@ = bin/solr zk ls :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc index 6a72e934ded2..9e43bee4949a 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc @@ -22,12 +22,6 @@ = bin/solr zk mkroot :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc index 1de113d09738..4f9d5acc42f6 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc @@ -22,12 +22,6 @@ = bin/solr zk mv :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc index e381d4de6453..4b317479e353 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc @@ -22,12 +22,6 @@ = bin/solr zk rm :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc index f42bc40c1c7a..1f862fbbeea8 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc @@ -22,12 +22,6 @@ = bin/solr zk upconfig :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc index e8e80cb65bf9..97dffc798b30 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc @@ -22,12 +22,6 @@ = bin/solr zk updateacls :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk.adoc index 991b4838142b..87d595782408 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk.adoc @@ -22,12 +22,6 @@ = bin/solr zk :page-toclevels: 2 -[WARNING] -==== -This page documents the *experimental* picocli implementation of `bin/solr`, which is not enabled by default. -For what `bin/solr` does by default, see xref:solr-control-script-reference.adoc[]. -See xref:cli/index.adoc[] to enable this implementation and for its known limitations. -==== // tag::picocli-generated-man-section-synopsis[] == Synopsis diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc index de678a1c1207..f7d3a526249a 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc @@ -27,11 +27,11 @@ More examples of SolrCLI in use are available throughout this Guide, particularl [NOTE] ==== -This page documents the `bin/solr` script as it behaves by default. +By default, `bin/solr` uses a picocli-based implementation. +See xref:cli/index.adoc[] for its commands and options. -An experimental re-implementation of the command line interface, built on picocli, is also included in this release. -It is disabled by default, and the options it accepts differ in places from those documented here. -See xref:cli/index.adoc[] if you would like to try it. +The sections below describe the legacy Apache Commons CLI implementation, which you can switch to by setting `SOLR_PICOCLI=false` in case you run into a problem with the default. +Options and the output may differ from the default CLI. ==== == Starting and Stopping diff --git a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc index 37a82e00720c..f6f3b5b22680 100644 --- a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc +++ b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc @@ -36,20 +36,15 @@ Solr 10.0 requires at least Java 21, while SolrJ 10.0 requires at least Java 17. == Solr 10.2 -=== Snapshot commands are now `bin/solr snapshot` sub-commands +=== Solr CLI now uses PicoCLI -The `snapshot-create`, `snapshot-delete`, `snapshot-describe`, `snapshot-export` and `snapshot-list` commands of the experimental picocli command line interface are replaced by the sub-commands of `bin/solr snapshot`: - -[source,bash] ----- -bin/solr snapshot create -c mycollection --snapshot-name snap1 -bin/solr snapshot list -c mycollection ----- +Solr has migrated the `bin/solr` command line tool from Apache Commons CLI to https://picocli.info/[picocli]. The old spellings still work and are hidden from the help and from this guide. They are deprecated in Solr 10.2 and are removed in Solr 11.0. The default command line interface is not changed. + == Solr 10.1 === Misc