This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch CAMEL-22861 in repository https://gitbox.apache.org/repos/asf/camel.git
commit e7d2f23cc2b6a316e1d9c1b69deb7c9f74fa6d69 Author: Andrea Cosentino <[email protected]> AuthorDate: Thu Jan 15 14:28:30 2026 +0100 CAMEL-22861 - Auto-generated Jbang commands documentation: Add support for adding examples Signed-off-by: Andrea Cosentino <[email protected]> --- .../pages/jbang-commands/camel-jbang-bind.adoc | 1 + .../camel-jbang-catalog-component.adoc | 1 + .../camel-jbang-catalog-dataformat.adoc | 1 + .../camel-jbang-catalog-dev-console.adoc | 1 + .../camel-jbang-catalog-kamelet.adoc | 1 + .../camel-jbang-catalog-language.adoc | 1 + .../jbang-commands/camel-jbang-catalog-other.adoc | 1 + .../camel-jbang-catalog-transformer.adoc | 1 + .../pages/jbang-commands/camel-jbang-catalog.adoc | 1 + .../jbang-commands/camel-jbang-cmd-browse.adoc | 1 + .../camel-jbang-cmd-disable-processor.adoc | 1 + .../camel-jbang-cmd-enable-processor.adoc | 1 + .../pages/jbang-commands/camel-jbang-cmd-gc.adoc | 1 + .../pages/jbang-commands/camel-jbang-cmd-load.adoc | 1 + .../jbang-commands/camel-jbang-cmd-logger.adoc | 1 + .../jbang-commands/camel-jbang-cmd-receive.adoc | 3 ++- .../jbang-commands/camel-jbang-cmd-reload.adoc | 1 + .../camel-jbang-cmd-reset-stats.adoc | 1 + .../camel-jbang-cmd-resume-route.adoc | 1 + .../camel-jbang-cmd-route-structure.adoc | 1 + .../pages/jbang-commands/camel-jbang-cmd-send.adoc | 3 ++- .../camel-jbang-cmd-start-group.adoc | 1 + .../camel-jbang-cmd-start-route.adoc | 1 + .../jbang-commands/camel-jbang-cmd-stop-group.adoc | 1 + .../jbang-commands/camel-jbang-cmd-stop-route.adoc | 1 + .../pages/jbang-commands/camel-jbang-cmd-stub.adoc | 1 + .../camel-jbang-cmd-suspend-route.adoc | 1 + .../camel-jbang-cmd-thread-dump.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-cmd.adoc | 1 + .../jbang-commands/camel-jbang-completion.adoc | 1 + .../jbang-commands/camel-jbang-config-get.adoc | 1 + .../jbang-commands/camel-jbang-config-list.adoc | 1 + .../jbang-commands/camel-jbang-config-set.adoc | 1 + .../jbang-commands/camel-jbang-config-unset.adoc | 1 + .../pages/jbang-commands/camel-jbang-config.adoc | 1 + .../pages/jbang-commands/camel-jbang-debug.adoc | 9 ++++--- .../camel-jbang-dependency-copy.adoc | 5 ++-- .../camel-jbang-dependency-list.adoc | 5 ++-- .../camel-jbang-dependency-runtime.adoc | 1 + .../camel-jbang-dependency-update.adoc | 5 ++-- .../jbang-commands/camel-jbang-dependency.adoc | 1 + .../pages/jbang-commands/camel-jbang-dirty.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-doc.adoc | 1 + .../pages/jbang-commands/camel-jbang-export.adoc | 5 ++-- .../pages/jbang-commands/camel-jbang-get-bean.adoc | 1 + .../jbang-commands/camel-jbang-get-blocked.adoc | 1 + .../camel-jbang-get-circuit-breaker.adoc | 1 + .../jbang-commands/camel-jbang-get-consumer.adoc | 1 + .../jbang-commands/camel-jbang-get-context.adoc | 1 + .../jbang-commands/camel-jbang-get-count.adoc | 1 + .../jbang-commands/camel-jbang-get-endpoint.adoc | 1 + .../jbang-commands/camel-jbang-get-event.adoc | 1 + .../jbang-commands/camel-jbang-get-groovy.adoc | 1 + .../jbang-commands/camel-jbang-get-group.adoc | 1 + .../jbang-commands/camel-jbang-get-health.adoc | 1 + .../jbang-commands/camel-jbang-get-history.adoc | 3 ++- .../jbang-commands/camel-jbang-get-inflight.adoc | 1 + .../camel-jbang-get-internal-task.adoc | 1 + .../jbang-commands/camel-jbang-get-kafka.adoc | 1 + .../jbang-commands/camel-jbang-get-metric.adoc | 1 + .../camel-jbang-get-platform-http.adoc | 1 + .../jbang-commands/camel-jbang-get-processor.adoc | 1 + .../jbang-commands/camel-jbang-get-producer.adoc | 1 + .../jbang-commands/camel-jbang-get-properties.adoc | 1 + .../pages/jbang-commands/camel-jbang-get-rest.adoc | 1 + .../camel-jbang-get-route-controller.adoc | 1 + .../jbang-commands/camel-jbang-get-route-dump.adoc | 1 + .../jbang-commands/camel-jbang-get-route.adoc | 1 + .../jbang-commands/camel-jbang-get-service.adoc | 1 + .../jbang-commands/camel-jbang-get-source.adoc | 1 + .../camel-jbang-get-startup-recorder.adoc | 1 + .../camel-jbang-get-transformer.adoc | 1 + .../jbang-commands/camel-jbang-get-variable.adoc | 1 + .../jbang-commands/camel-jbang-get-vault.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-get.adoc | 1 + .../pages/jbang-commands/camel-jbang-hawtio.adoc | 1 + .../jbang-commands/camel-jbang-infra-get.adoc | 1 + .../jbang-commands/camel-jbang-infra-list.adoc | 1 + .../jbang-commands/camel-jbang-infra-log.adoc | 1 + .../pages/jbang-commands/camel-jbang-infra-ps.adoc | 1 + .../jbang-commands/camel-jbang-infra-run.adoc | 1 + .../jbang-commands/camel-jbang-infra-stop.adoc | 1 + .../pages/jbang-commands/camel-jbang-infra.adoc | 1 + .../pages/jbang-commands/camel-jbang-init.adoc | 1 + .../pages/jbang-commands/camel-jbang-jolokia.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-log.adoc | 1 + .../pages/jbang-commands/camel-jbang-nano.adoc | 1 + .../jbang-commands/camel-jbang-plugin-add.adoc | 1 + .../jbang-commands/camel-jbang-plugin-delete.adoc | 1 + .../jbang-commands/camel-jbang-plugin-get.adoc | 1 + .../pages/jbang-commands/camel-jbang-plugin.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-ps.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-run.adoc | 12 ++++++--- .../pages/jbang-commands/camel-jbang-sbom.adoc | 5 ++-- .../pages/jbang-commands/camel-jbang-script.adoc | 1 + .../pages/jbang-commands/camel-jbang-shell.adoc | 1 + .../pages/jbang-commands/camel-jbang-stop.adoc | 1 + .../jbang-commands/camel-jbang-top-context.adoc | 1 + .../jbang-commands/camel-jbang-top-group.adoc | 1 + .../jbang-commands/camel-jbang-top-processor.adoc | 1 + .../jbang-commands/camel-jbang-top-route.adoc | 1 + .../jbang-commands/camel-jbang-top-source.adoc | 1 + .../ROOT/pages/jbang-commands/camel-jbang-top.adoc | 1 + .../pages/jbang-commands/camel-jbang-trace.adoc | 3 ++- .../camel-jbang-transform-message.adoc | 1 + .../camel-jbang-transform-route.adoc | 1 + .../jbang-commands/camel-jbang-transform.adoc | 1 + .../jbang-commands/camel-jbang-update-list.adoc | 1 + .../jbang-commands/camel-jbang-update-run.adoc | 1 + .../pages/jbang-commands/camel-jbang-update.adoc | 1 + .../jbang-commands/camel-jbang-version-get.adoc | 1 + .../jbang-commands/camel-jbang-version-list.adoc | 1 + .../jbang-commands/camel-jbang-version-set.adoc | 1 + .../pages/jbang-commands/camel-jbang-version.adoc | 1 + .../ROOT/pages/jbang-commands/examples/run.adoc | 29 ++++++++++++++++++++++ .../META-INF/camel-jbang-commands-metadata.json | 16 ++++++------ .../camel/tooling/model/JBangCommandModel.java | 13 ++++++++++ .../org/apache/camel/tooling/model/JsonMapper.java | 4 +++ .../PrepareCamelJBangCommandsDocMojo.java | 15 +++++++++++ .../packaging/PrepareCamelJBangCommandsMojo.java | 2 ++ .../src/main/resources/jbang-command-page.mvel | 4 +++ 121 files changed, 214 insertions(+), 30 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-bind.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-bind.adoc index f2b026c4fc32..ed22844f67e5 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-bind.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-bind.adoc @@ -28,3 +28,4 @@ camel bind [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-component.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-component.adoc index 879075f8df18..0689e6c949c9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-component.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-component.adoc @@ -34,3 +34,4 @@ camel catalog component [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dataformat.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dataformat.adoc index 940b534e7b40..9f617f9d2a7c 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dataformat.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dataformat.adoc @@ -34,3 +34,4 @@ camel catalog dataformat [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dev-console.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dev-console.adoc index 27c8d9526726..9d7e793408a4 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dev-console.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-dev-console.adoc @@ -34,3 +34,4 @@ camel catalog dev-console [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-kamelet.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-kamelet.adoc index 995d4fc63ba1..9ef1464a2b83 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-kamelet.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-kamelet.adoc @@ -26,3 +26,4 @@ camel catalog kamelet [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-language.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-language.adoc index 8475697e67d7..a6a6be0c84ac 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-language.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-language.adoc @@ -34,3 +34,4 @@ camel catalog language [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-other.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-other.adoc index e1e0096df8ed..e0991c182f4e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-other.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-other.adoc @@ -34,3 +34,4 @@ camel catalog other [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-transformer.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-transformer.adoc index 1f75b205e999..91b6ffe9f486 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-transformer.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog-transformer.adoc @@ -34,3 +34,4 @@ camel catalog transformer [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog.adoc index 89a917f1ea73..8c1636431233 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-catalog.adoc @@ -37,3 +37,4 @@ camel catalog [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-browse.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-browse.adoc index 845a88cdbef0..b061dcd23b9e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-browse.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-browse.adoc @@ -37,3 +37,4 @@ camel cmd browse [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-disable-processor.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-disable-processor.adoc index 0f391033f41b..ed5536e0039e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-disable-processor.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-disable-processor.adoc @@ -23,3 +23,4 @@ camel cmd disable-processor [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-enable-processor.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-enable-processor.adoc index 2e2dc72d3bd9..4fad7e4f2a83 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-enable-processor.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-enable-processor.adoc @@ -23,3 +23,4 @@ camel cmd enable-processor [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-gc.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-gc.adoc index 5a564a7553ff..aa7cc891c00f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-gc.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-gc.adoc @@ -22,3 +22,4 @@ camel cmd gc [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-load.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-load.adoc index 7358a7bb6600..46767e80240f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-load.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-load.adoc @@ -24,3 +24,4 @@ camel cmd load [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-logger.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-logger.adoc index 60d8db29d765..dd4466679415 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-logger.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-logger.adoc @@ -25,3 +25,4 @@ camel cmd logger [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-receive.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-receive.adoc index cb3d388d06b3..2e9a1caded71 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-receive.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-receive.adoc @@ -32,7 +32,7 @@ camel cmd receive [options] | `--prefix` | Print prefix with running Camel integration name. auto=only prefix when running multiple integrations. true=always prefix. false=prefix off. | auto | String | `--pretty` | Pretty print message body when using JSon or XML format | | boolean | `--prop,--property` | Additional properties; override existing (only applicable when NOT using an existing running Camel) | | String -| `--properties` | comma separated list of properties file (only applicable when NOT using an existing running Camel) + (ex. /path/to/file.properties,/path/to/other.properties | | String +| `--properties` | comma separated list of properties file (only applicable when NOT using an existing running Camel) (ex. /path/to/file.properties,/path/to/other.properties | | String | `--short-uri` | List endpoint URI without query parameters (short) | | boolean | `--show-body` | Show message body in received messages | true | boolean | `--show-exchange-properties` | Show exchange properties in received messages | false | boolean @@ -46,3 +46,4 @@ camel cmd receive [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reload.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reload.adoc index 8b59c637e5a3..44e91d0f9af6 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reload.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reload.adoc @@ -22,3 +22,4 @@ camel cmd reload [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reset-stats.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reset-stats.adoc index 9a83d7ff434a..b043d552d260 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reset-stats.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-reset-stats.adoc @@ -22,3 +22,4 @@ camel cmd reset-stats [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-resume-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-resume-route.adoc index 8a6b62caed9d..5784fb00b2bb 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-resume-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-resume-route.adoc @@ -23,3 +23,4 @@ camel cmd resume-route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-route-structure.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-route-structure.adoc index 6373d4425de4..f0c61f481ee2 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-route-structure.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-route-structure.adoc @@ -26,3 +26,4 @@ camel cmd route-structure [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-send.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-send.adoc index bd4ebccaabf7..1a011d2ebaa5 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-send.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-send.adoc @@ -26,7 +26,7 @@ camel cmd send [options] | `--poll` | Poll instead of sending a message. This can be used to receive latest message from a Kafka topic or JMS queue. | | boolean | `--pretty` | Pretty print response message body (InOut) when using JSon or XML format | | boolean | `--prop,--property` | Additional properties; override existing (only applicable when NOT using an existing running Camel) | | String -| `--properties` | comma separated list of properties file (only applicable when NOT using an existing running Camel) + (ex. /path/to/file.properties,/path/to/other.properties | | String +| `--properties` | comma separated list of properties file (only applicable when NOT using an existing running Camel) (ex. /path/to/file.properties,/path/to/other.properties | | String | `--reply` | Whether to expect a reply message (InOut vs InOut messaging style) | | boolean | `--reply-file` | Saves reply message to the file with the given name (override if exists) | | String | `--show-body` | Show message body from response message (InOut) | true | boolean @@ -38,3 +38,4 @@ camel cmd send [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-group.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-group.adoc index a1114e5de6fb..d594569661b6 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-group.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-group.adoc @@ -23,3 +23,4 @@ camel cmd start-group [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-route.adoc index 1ac05779fed4..c46e79e6121c 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-start-route.adoc @@ -23,3 +23,4 @@ camel cmd start-route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-group.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-group.adoc index b4c072fe7d8a..38a00e1cb273 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-group.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-group.adoc @@ -23,3 +23,4 @@ camel cmd stop-group [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-route.adoc index acc5c254f11f..014fdae51646 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stop-route.adoc @@ -23,3 +23,4 @@ camel cmd stop-route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stub.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stub.adoc index 2ab3a4d95db3..d83c7c6b1d88 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stub.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-stub.adoc @@ -36,3 +36,4 @@ camel cmd stub [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-suspend-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-suspend-route.adoc index 025433207000..4dfa0b5f84e1 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-suspend-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-suspend-route.adoc @@ -23,3 +23,4 @@ camel cmd suspend-route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-thread-dump.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-thread-dump.adoc index ed447ad29bb2..1eae0351f47f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-thread-dump.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd-thread-dump.adoc @@ -28,3 +28,4 @@ camel cmd thread-dump [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd.adoc index 78e87885dfd4..0d0c1ec7544b 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-cmd.adoc @@ -49,3 +49,4 @@ camel cmd [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-completion.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-completion.adoc index 0aae6b94dbab..c5c7c254328f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-completion.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-completion.adoc @@ -22,3 +22,4 @@ camel completion [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-get.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-get.adoc index 1991436d5530..810879c7bfe7 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-get.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-get.adoc @@ -23,3 +23,4 @@ camel config get [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-list.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-list.adoc index 067518f289b1..bb4ca9832f9b 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-list.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-list.adoc @@ -23,3 +23,4 @@ camel config list [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-set.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-set.adoc index b955c317d6f5..413aab2d1131 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-set.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-set.adoc @@ -23,3 +23,4 @@ camel config set [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-unset.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-unset.adoc index a88a367a6c95..42de87ab6e01 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-unset.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config-unset.adoc @@ -23,3 +23,4 @@ camel config unset [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config.adoc index 2e6ecde98cca..bb958c82a0b2 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-config.adoc @@ -34,3 +34,4 @@ camel config [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-debug.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-debug.adoc index 09d7353a5f89..f7bcff1d740b 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-debug.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-debug.adoc @@ -38,7 +38,7 @@ camel debug [options] | `--ignore-loading-error` | Whether to ignore route loading and compilation errors (use this with care!) | false | boolean | `--jfr` | Enables Java Flight Recorder saving recording to disk on exit | false | boolean | `--jfr-profile` | Java Flight Recorder profile to use (such as default or profile) | | String -| `--jvm-debug` | To enable JVM remote debugging on port 4004 by default. The supported values are true to + enable the remote debugging, false to disable the remote debugging or a number to use a custom port | | int +| `--jvm-debug` | To enable JVM remote debugging on port 4004 by default. The supported values are true to enable the remote debugging, false to disable the remote debugging or a number to use a custom port | | int | `--kamelets-version` | Apache Camel Kamelets version | | String | `--lazy-bean` | Whether to use lazy bean initialization (can help with complex classloading issues) | false | boolean | `--local-kamelet-dir` | Local directory (or github link) for loading Kamelets (takes precedence). Multiple directories can be specified separated by comma. | | String @@ -53,7 +53,7 @@ camel debug [options] | `--mask` | Whether to mask endpoint URIs to avoid printing sensitive information such as password or access keys | | boolean | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--max-idle-seconds` | For how long time in seconds Camel can be idle before stopping | 0 | int | `--max-messages` | Max number of messages to process before stopping | 0 | int @@ -70,7 +70,7 @@ camel debug [options] | `--profile` | Profile to run (dev, test, or prod). | dev | String | `--prompt` | Allow user to type in required parameters in prompt if not present in application | false | boolean | `--prop,--property` | Additional properties (override existing) | | String -| `--properties` | comma separated list of properties file + (ex. /path/to/file.properties,/path/to/other.properties | | String +| `--properties` | comma separated list of properties file (ex. /path/to/file.properties,/path/to/other.properties | | String | `--quarkus-artifact-id` | Quarkus Platform Maven artifactId | quarkus-bom | String | `--quarkus-group-id` | Quarkus Platform Maven groupId | io.quarkus.platform | String | `--quarkus-version` | Quarkus Platform version | RuntimeType.QUARKUS_VERSION | String @@ -88,10 +88,11 @@ camel debug [options] | `--source-dir` | Source directory for dynamically loading Camel file(s) to run. When using this, then files cannot be specified at the same time. | | String | `--spring-boot-version` | Spring Boot version | RuntimeType.SPRING_BOOT_VERSION | String | `--stop-on-exit` | Whether to stop the running Camel on exit | true | boolean -| `--stub` | Stubs all the matching endpoint uri with the given component name or pattern. + Multiple names can be separated by comma. (all = stub all endpoints). | | String +| `--stub` | Stubs all the matching endpoint uri with the given component name or pattern. Multiple names can be separated by comma. (all = stub all endpoints). | | String | `--timestamp` | Print timestamp. | true | boolean | `--trace` | Enables trace logging of the routed messages | false | boolean | `--verbose` | Verbose output of startup activity (dependency resolution and downloading | false | boolean | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-copy.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-copy.adoc index 255a324afd4d..d0d3a850f05e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-copy.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-copy.adoc @@ -45,7 +45,7 @@ camel dependency copy [options] | `--management-port` | To use a dedicated port for HTTP management | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--maven-wrapper` | Include Maven Wrapper files in exported project | true | boolean | `--name` | The integration name. Use this when the name should not get derived otherwise. | | String @@ -53,7 +53,7 @@ camel dependency copy [options] | `--open-api` | Adds an OpenAPI spec from the given file (json or yaml file) | | String | `--output` | Output format (gav, maven, jbang) | gav | String | `--output-directory` | Directory where dependencies should be copied | lib | String -| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. + Use false to turn off and not include package name in the Java source files. | | String +| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files. | | String | `--package-scan-jars` | Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang | false | boolean | `--port` | Embeds a local HTTP server on this port | | int | `--profile` | Profile to export (dev, test, or prod). | | String @@ -70,3 +70,4 @@ camel dependency copy [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-list.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-list.adoc index fe6c7857a298..cd7e75dda8f9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-list.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-list.adoc @@ -45,14 +45,14 @@ camel dependency list [options] | `--management-port` | To use a dedicated port for HTTP management | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--maven-wrapper` | Include Maven Wrapper files in exported project | true | boolean | `--name` | The integration name. Use this when the name should not get derived otherwise. | | String | `--observe` | Enable observability services | false | boolean | `--open-api` | Adds an OpenAPI spec from the given file (json or yaml file) | | String | `--output` | Output format (gav, maven, jbang) | gav | String -| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. + Use false to turn off and not include package name in the Java source files. | | String +| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files. | | String | `--package-scan-jars` | Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang | false | boolean | `--port` | Embeds a local HTTP server on this port | | int | `--profile` | Profile to export (dev, test, or prod). | | String @@ -69,3 +69,4 @@ camel dependency list [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-runtime.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-runtime.adoc index 096e6ebb5fa4..2f8f26f7a7d9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-runtime.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-runtime.adoc @@ -25,3 +25,4 @@ camel dependency runtime [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-update.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-update.adoc index c45b94839b92..bc004afa5d61 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-update.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency-update.adoc @@ -46,14 +46,14 @@ camel dependency update [options] | `--management-port` | To use a dedicated port for HTTP management | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--maven-wrapper` | Include Maven Wrapper files in exported project | true | boolean | `--name` | The integration name. Use this when the name should not get derived otherwise. | | String | `--observe` | Enable observability services | false | boolean | `--open-api` | Adds an OpenAPI spec from the given file (json or yaml file) | | String | `--output` | Output format (gav, maven, jbang) | gav | String -| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. + Use false to turn off and not include package name in the Java source files. | | String +| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files. | | String | `--package-scan-jars` | Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang | false | boolean | `--port` | Embeds a local HTTP server on this port | | int | `--profile` | Profile to export (dev, test, or prod). | | String @@ -70,3 +70,4 @@ camel dependency update [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency.adoc index 4a40a8025d25..63e3f40f6cd9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dependency.adoc @@ -34,3 +34,4 @@ camel dependency [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dirty.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dirty.adoc index d4b025657e89..71f9e1b42bd0 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dirty.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-dirty.adoc @@ -23,3 +23,4 @@ camel dirty [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-doc.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-doc.adoc index f459ee0e3f7f..417ac09990dc 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-doc.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-doc.adoc @@ -33,3 +33,4 @@ camel doc [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-export.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-export.adoc index 32c1781e84bc..23dbb66d6c15 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-export.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-export.adoc @@ -45,13 +45,13 @@ camel export [options] | `--management-port` | To use a dedicated port for HTTP management | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--maven-wrapper` | Include Maven Wrapper files in exported project | true | boolean | `--name` | The integration name. Use this when the name should not get derived otherwise. | | String | `--observe` | Enable observability services | false | boolean | `--open-api` | Adds an OpenAPI spec from the given file (json or yaml file) | | String -| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. + Use false to turn off and not include package name in the Java source files. | | String +| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files. | | String | `--package-scan-jars` | Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang | false | boolean | `--port` | Embeds a local HTTP server on this port | | int | `--profile` | Profile to export (dev, test, or prod). | | String @@ -68,3 +68,4 @@ camel export [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-bean.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-bean.adoc index d1b2506ae280..32f601f4b709 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-bean.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-bean.adoc @@ -28,3 +28,4 @@ camel get bean [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-blocked.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-blocked.adoc index 6a20ddb01467..7ba895d8bd7a 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-blocked.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-blocked.adoc @@ -24,3 +24,4 @@ camel get blocked [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-circuit-breaker.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-circuit-breaker.adoc index 719e4a789ffc..d7b85a10409f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-circuit-breaker.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-circuit-breaker.adoc @@ -24,3 +24,4 @@ camel get circuit-breaker [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-consumer.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-consumer.adoc index 3ea610334b9e..5bd1777b7c00 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-consumer.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-consumer.adoc @@ -29,3 +29,4 @@ camel get consumer [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-context.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-context.adoc index 57735acbb0b9..2ffa629c5ae6 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-context.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-context.adoc @@ -25,3 +25,4 @@ camel get context [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-count.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-count.adoc index 4463407ff485..c5d0e45c6b7d 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-count.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-count.adoc @@ -26,3 +26,4 @@ camel get count [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-endpoint.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-endpoint.adoc index bf0b4fdea379..931dd6152ea7 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-endpoint.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-endpoint.adoc @@ -30,3 +30,4 @@ camel get endpoint [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-event.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-event.adoc index ba2ddc9b0cc6..36cda91ee973 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-event.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-event.adoc @@ -25,3 +25,4 @@ camel get event [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-groovy.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-groovy.adoc index 6cc14c850b4e..93506034994a 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-groovy.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-groovy.adoc @@ -24,3 +24,4 @@ camel get groovy [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-group.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-group.adoc index 3349be7e8e7a..59e4dd8e6d70 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-group.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-group.adoc @@ -28,3 +28,4 @@ camel get group [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-health.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-health.adoc index bbc29e10c3cd..d988ee64a88f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-health.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-health.adoc @@ -30,3 +30,4 @@ camel get health [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-history.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-history.adoc index 077d4741d366..3aba5a683694 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-history.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-history.adoc @@ -20,7 +20,7 @@ camel get history [options] |=== | Option | Description | Default | Type | `--ago` | Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp. | | boolean -| `--depth` | Depth of tracing. 0=Created+Completed. 1=All events on 1st route, 2=All events on 1st+2nd depth, and so on. 9 = all events on every depth. | 9 | int +| `--depth` | Depth of tracing. 0=Created Completed. 1=All events on 1st route, 2=All events on 1st 2nd depth, and so on. 9 = all events on every depth. | 9 | int | `--it` | Interactive mode for enhanced history information | | boolean | `--limit-split` | Limit Split to a maximum number of entries to be displayed | | int | `--logging-color` | Use colored logging | true | boolean @@ -37,3 +37,4 @@ camel get history [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-inflight.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-inflight.adoc index ba3c23f5d028..e64962cb6218 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-inflight.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-inflight.adoc @@ -24,3 +24,4 @@ camel get inflight [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-internal-task.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-internal-task.adoc index 977043e76ef5..6d518fc9df4f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-internal-task.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-internal-task.adoc @@ -24,3 +24,4 @@ camel get internal-task [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-kafka.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-kafka.adoc index 5372924357a2..e710dd7b0110 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-kafka.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-kafka.adoc @@ -27,3 +27,4 @@ camel get kafka [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-metric.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-metric.adoc index b388c3c5956a..ae466dc1a509 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-metric.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-metric.adoc @@ -28,3 +28,4 @@ camel get metric [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-platform-http.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-platform-http.adoc index 9c21e77035cd..f1d426900de3 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-platform-http.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-platform-http.adoc @@ -25,3 +25,4 @@ camel get platform-http [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-processor.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-processor.adoc index 3b89417b45b7..89c6603462ef 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-processor.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-processor.adoc @@ -34,3 +34,4 @@ camel get processor [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-producer.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-producer.adoc index d1c24867af8a..0b0aa1f290ab 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-producer.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-producer.adoc @@ -28,3 +28,4 @@ camel get producer [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-properties.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-properties.adoc index 9810abcde4f9..0ce4298f3a4c 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-properties.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-properties.adoc @@ -28,3 +28,4 @@ camel get properties [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-rest.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-rest.adoc index 293b45392071..b88070d684c9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-rest.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-rest.adoc @@ -25,3 +25,4 @@ camel get rest [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-controller.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-controller.adoc index ae34f7f9eae5..efad90acf7c0 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-controller.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-controller.adoc @@ -27,3 +27,4 @@ camel get route-controller [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-dump.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-dump.adoc index fd0974a3092f..8f1f3302eb40 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-dump.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route-dump.adoc @@ -27,3 +27,4 @@ camel get route-dump [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route.adoc index 6e894dcd7b0a..f1653bcc8c32 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-route.adoc @@ -36,3 +36,4 @@ camel get route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-service.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-service.adoc index c32ef19184f6..18db29fbe58a 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-service.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-service.adoc @@ -27,3 +27,4 @@ camel get service [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-source.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-source.adoc index d5ed98748c89..bbcd520181eb 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-source.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-source.adoc @@ -24,3 +24,4 @@ camel get source [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-startup-recorder.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-startup-recorder.adoc index 0932d864d58d..a4a2ebccdb58 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-startup-recorder.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-startup-recorder.adoc @@ -24,3 +24,4 @@ camel get startup-recorder [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-transformer.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-transformer.adoc index 215338cb6bf2..3c4611729ccb 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-transformer.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-transformer.adoc @@ -23,3 +23,4 @@ camel get transformer [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-variable.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-variable.adoc index e325dc096409..b3abe7a630fb 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-variable.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-variable.adoc @@ -24,3 +24,4 @@ camel get variable [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-vault.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-vault.adoc index ed077539fbcb..f995cb144864 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-vault.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get-vault.adoc @@ -24,3 +24,4 @@ camel get vault [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get.adoc index 33933a608ae5..5b889526db43 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-get.adoc @@ -61,3 +61,4 @@ camel get [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-hawtio.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-hawtio.adoc index 1b987a692b5b..3ed8568de5ee 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-hawtio.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-hawtio.adoc @@ -25,3 +25,4 @@ camel hawtio [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-get.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-get.adoc index 7af694473475..c334826078e4 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-get.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-get.adoc @@ -23,3 +23,4 @@ camel infra get [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-list.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-list.adoc index 748aa8426b46..79012810d9cf 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-list.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-list.adoc @@ -23,3 +23,4 @@ camel infra list [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-log.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-log.adoc index 9687333a78c7..5ad27765daaf 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-log.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-log.adoc @@ -23,3 +23,4 @@ camel infra log [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-ps.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-ps.adoc index b6675cc2ec99..c135fdd7be23 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-ps.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-ps.adoc @@ -23,3 +23,4 @@ camel infra ps [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-run.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-run.adoc index 264f7fed0c03..6c3cf3e68852 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-run.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-run.adoc @@ -25,3 +25,4 @@ camel infra run [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-stop.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-stop.adoc index b5bb762ad4e3..73c3882c4a14 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-stop.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra-stop.adoc @@ -24,3 +24,4 @@ camel infra stop [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra.adoc index a1482864086b..0c31a2050f12 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-infra.adoc @@ -37,3 +37,4 @@ camel infra [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-init.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-init.adoc index a4a2b7882121..db8aee77b169 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-init.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-init.adoc @@ -28,3 +28,4 @@ camel init [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-jolokia.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-jolokia.adoc index 683738e062ff..bf1a05952214 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-jolokia.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-jolokia.adoc @@ -24,3 +24,4 @@ camel jolokia [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-log.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-log.adoc index 243435def90f..69f3411982dc 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-log.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-log.adoc @@ -31,3 +31,4 @@ camel log [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-nano.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-nano.adoc index 96d89a347220..1d5dc1f6169a 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-nano.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-nano.adoc @@ -22,3 +22,4 @@ camel nano [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-add.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-add.adoc index 88a77c97b5c2..3f6cfc53d295 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-add.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-add.adoc @@ -30,3 +30,4 @@ camel plugin add [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-delete.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-delete.adoc index b1c4bc57bbba..31ebeb92b66c 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-delete.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-delete.adoc @@ -22,3 +22,4 @@ camel plugin delete [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-get.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-get.adoc index 72d5152d7816..be343bbd3f71 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-get.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin-get.adoc @@ -24,3 +24,4 @@ camel plugin get [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin.adoc index 18843a511cb7..d345109609ad 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-plugin.adoc @@ -33,3 +33,4 @@ camel plugin [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-ps.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-ps.adoc index c6e29ae8d49b..0cac28a85bc3 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-ps.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-ps.adoc @@ -27,3 +27,4 @@ camel ps [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-run.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-run.adoc index 2b7622b50e3f..0dbeab2db679 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-run.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-run.adoc @@ -36,7 +36,7 @@ camel run [options] | `--ignore-loading-error` | Whether to ignore route loading and compilation errors (use this with care!) | false | boolean | `--jfr` | Enables Java Flight Recorder saving recording to disk on exit | false | boolean | `--jfr-profile` | Java Flight Recorder profile to use (such as default or profile) | | String -| `--jvm-debug` | To enable JVM remote debugging on port 4004 by default. The supported values are true to + enable the remote debugging, false to disable the remote debugging or a number to use a custom port | | int +| `--jvm-debug` | To enable JVM remote debugging on port 4004 by default. The supported values are true to enable the remote debugging, false to disable the remote debugging or a number to use a custom port | | int | `--kamelets-version` | Apache Camel Kamelets version | | String | `--lazy-bean` | Whether to use lazy bean initialization (can help with complex classloading issues) | false | boolean | `--local-kamelet-dir` | Local directory (or github link) for loading Kamelets (takes precedence). Multiple directories can be specified separated by comma. | | String @@ -49,7 +49,7 @@ camel run [options] | `--management-port` | To use a dedicated port for HTTP management (use 0 to dynamic assign a free random port number) | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--max-idle-seconds` | For how long time in seconds Camel can be idle before stopping | 0 | int | `--max-messages` | Max number of messages to process before stopping | 0 | int @@ -64,7 +64,7 @@ camel run [options] | `--profile` | Profile to run (dev, test, or prod). | dev | String | `--prompt` | Allow user to type in required parameters in prompt if not present in application | false | boolean | `--prop,--property` | Additional properties (override existing) | | String -| `--properties` | comma separated list of properties file + (ex. /path/to/file.properties,/path/to/other.properties | | String +| `--properties` | comma separated list of properties file (ex. /path/to/file.properties,/path/to/other.properties | | String | `--quarkus-artifact-id` | Quarkus Platform Maven artifactId | quarkus-bom | String | `--quarkus-group-id` | Quarkus Platform Maven groupId | io.quarkus.platform | String | `--quarkus-version` | Quarkus Platform version | RuntimeType.QUARKUS_VERSION | String @@ -74,9 +74,13 @@ camel run [options] | `--skip-plugins` | Skip plugins during export | false | boolean | `--source-dir` | Source directory for dynamically loading Camel file(s) to run. When using this, then files cannot be specified at the same time. | | String | `--spring-boot-version` | Spring Boot version | RuntimeType.SPRING_BOOT_VERSION | String -| `--stub` | Stubs all the matching endpoint uri with the given component name or pattern. + Multiple names can be separated by comma. (all = stub all endpoints). | | String +| `--stub` | Stubs all the matching endpoint uri with the given component name or pattern. Multiple names can be separated by comma. (all = stub all endpoints). | | String | `--trace` | Enables trace logging of the routed messages | false | boolean | `--verbose` | Verbose output of startup activity (dependency resolution and downloading | false | boolean | `-h,--help` | Display the help and sub-commands | | boolean |=== + + +include::examples/run.adoc[] + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-sbom.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-sbom.adoc index 93cda3f87e58..e82f8f7b9ae4 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-sbom.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-sbom.adoc @@ -46,7 +46,7 @@ camel sbom [options] | `--management-port` | To use a dedicated port for HTTP management | | int | `--maven-apache-snapshot-enabled` | Whether downloading JARs from ASF Maven Snapshot repository is enabled | true | boolean | `--maven-central-enabled` | Whether downloading JARs from Maven Central repository is enabled | true | boolean -| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. + If set to false, not even the default ~/.m2/settings.xml will be used. | | String +| `--maven-settings` | Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. | | String | `--maven-settings-security` | Optional location of Maven settings-security.xml file to decrypt settings.xml | | String | `--maven-wrapper` | Include Maven Wrapper files in exported project | true | boolean | `--name` | The integration name. Use this when the name should not get derived otherwise. | | String @@ -54,7 +54,7 @@ camel sbom [options] | `--open-api` | Adds an OpenAPI spec from the given file (json or yaml file) | | String | `--output-directory` | Directory where the SBOM will be saved | . | String | `--output-name` | Output name of the SBOM file | sbom | String -| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. + Use false to turn off and not include package name in the Java source files. | | String +| `--package-name` | For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files. | | String | `--package-scan-jars` | Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang | false | boolean | `--port` | Embeds a local HTTP server on this port | | int | `--profile` | Profile to export (dev, test, or prod). | | String @@ -74,3 +74,4 @@ camel sbom [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-script.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-script.adoc index b373a633e23a..1a61bc788d5f 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-script.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-script.adoc @@ -29,3 +29,4 @@ camel script [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-shell.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-shell.adoc index 0d7f65cb955c..a0220aa0110a 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-shell.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-shell.adoc @@ -22,3 +22,4 @@ camel shell [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-stop.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-stop.adoc index 0f04a6162d14..834a831b3870 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-stop.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-stop.adoc @@ -23,3 +23,4 @@ camel stop [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-context.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-context.adoc index c10e34eda6b9..25b43d2d860c 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-context.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-context.adoc @@ -24,3 +24,4 @@ camel top context [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-group.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-group.adoc index 3af51dd14a93..db86636f41d9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-group.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-group.adoc @@ -28,3 +28,4 @@ camel top group [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-processor.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-processor.adoc index f847e3ed4d02..9c9e19df5940 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-processor.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-processor.adoc @@ -34,3 +34,4 @@ camel top processor [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-route.adoc index c142acd0a681..37ccb11b67a5 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-route.adoc @@ -36,3 +36,4 @@ camel top route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-source.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-source.adoc index 1f2d9b3ff6eb..c30ab0980bf1 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-source.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top-source.adoc @@ -25,3 +25,4 @@ camel top source [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top.adoc index 619ad4980a07..1c71a9ad9568 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-top.adoc @@ -36,3 +36,4 @@ camel top [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-trace.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-trace.adoc index 9da4ac3d2fd4..8686247b6e04 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-trace.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-trace.adoc @@ -22,7 +22,7 @@ camel trace [options] | `--action` | Action to start, stop, clear, list status, or dump traces | status | String | `--ago` | Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp. | | boolean | `--compact` | Compact output (no empty line separating traced messages) | true | boolean -| `--depth` | Depth of tracing. 0=Created+Completed. 1=All events on 1st route, 2=All events on 1st+2nd depth, and so on. 9 = all events on every depth. | 9 | int +| `--depth` | Depth of tracing. 0=Created Completed. 1=All events on 1st route, 2=All events on 1st 2nd depth, and so on. 9 = all events on every depth. | 9 | int | `--find` | Find and highlight matching text (ignore case). | | String | `--follow` | Keep following and outputting new traces (press enter to exit). | true | boolean | `--grep` | Filter traces to only output trace matching text (ignore case). | | String @@ -44,3 +44,4 @@ camel trace [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-message.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-message.adoc index c647ed540dd9..2e50c308475e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-message.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-message.adoc @@ -41,3 +41,4 @@ camel transform message [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-route.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-route.adoc index 92ced3b44f89..4134449a2d67 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-route.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform-route.adoc @@ -27,3 +27,4 @@ camel transform route [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform.adoc index 4fcf0c8c98d8..782e71c87cef 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-transform.adoc @@ -32,3 +32,4 @@ camel transform [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-list.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-list.adoc index 0acb609009ba..6f83e9e7771e 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-list.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-list.adoc @@ -25,3 +25,4 @@ camel update list [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-run.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-run.adoc index c8b5725749fb..cb162b49efb9 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-run.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update-run.adoc @@ -22,3 +22,4 @@ camel update run [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update.adoc index ad14171630b9..41913c179888 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-update.adoc @@ -32,3 +32,4 @@ camel update [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-get.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-get.adoc index 343700a3fad3..a283ff357036 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-get.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-get.adoc @@ -23,3 +23,4 @@ camel version get [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-list.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-list.adoc index b07f578f58c4..9d649637baea 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-list.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-list.adoc @@ -39,3 +39,4 @@ camel version list [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-set.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-set.adoc index 3efd51072454..eab7c8ba69b6 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-set.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version-set.adoc @@ -26,3 +26,4 @@ camel version set [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version.adoc index dc471b4653ab..dec808bd74a0 100644 --- a/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version.adoc +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-version.adoc @@ -33,3 +33,4 @@ camel version [options] | `-h,--help` | Display the help and sub-commands | | boolean |=== + diff --git a/docs/user-manual/modules/ROOT/pages/jbang-commands/examples/run.adoc b/docs/user-manual/modules/ROOT/pages/jbang-commands/examples/run.adoc new file mode 100644 index 000000000000..9610a6b09f77 --- /dev/null +++ b/docs/user-manual/modules/ROOT/pages/jbang-commands/examples/run.adoc @@ -0,0 +1,29 @@ +== Examples + +Run a simple Java DSL route: + +[source,bash] +---- +camel run hello.java +---- + +Run with live reload enabled (dev mode): + +[source,bash] +---- +camel run hello.java --dev +---- + +Run a YAML route: + +[source,bash] +---- +camel run my-route.yaml +---- + +Run with additional dependencies: + +[source,bash] +---- +camel run hello.java --dep=camel-jackson +---- diff --git a/dsl/camel-jbang/camel-jbang-core/src/generated/resources/META-INF/camel-jbang-commands-metadata.json b/dsl/camel-jbang/camel-jbang-core/src/generated/resources/META-INF/camel-jbang-commands-metadata.json index 714a4429a500..4e7c866e22ad 100644 --- a/dsl/camel-jbang/camel-jbang-core/src/generated/resources/META-INF/camel-jbang-commands-metadata.json +++ b/dsl/camel-jbang/camel-jbang-core/src/generated/resources/META-INF/camel-jbang-commands-metadata.json @@ -2,15 +2,15 @@ "commands": [ { "name": "bind", "fullName": "bind", "description": "Bind source and sink Kamelets as a new Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.bind.Bind", "options": [ { "names": "--error-handler", "description": "Add error handler (none|log|sink:<endpoint>). Sink endpoints are expected in the format [[apigroup\/]version:]kind:[namespace\/]name, plain Camel URIs or Kamelet name.", "javaType": "java.lang.String", "type": "string" }, { "names": "--output", "d [...] { "name": "catalog", "fullName": "catalog", "description": "List artifacts from Camel Catalog", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.catalog.CatalogCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "component", "fullName": "catalog component", "description": "List components from the Camel Catalog", "sourceClass": "org.apache.camel.dsl.jbang.co [...] - { "name": "cmd", "fullName": "cmd", "description": "Performs commands in the running Camel integrations, such as start\/stop route, or change logging levels.", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.action.CamelAction", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "browse", "fullName": "cmd browse", "description": "Browse pending messages on endpoints [...] + { "name": "cmd", "fullName": "cmd", "description": "Performs commands in the running Camel integrations, such as start\/stop route, or change logging levels.", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.action.CamelAction", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "browse", "fullName": "cmd browse", "description": "Browse pending messages on endpoints [...] { "name": "completion", "fullName": "completion", "description": "Generate completion script for bash\/zsh", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Complete", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ] }, { "name": "config", "fullName": "config", "description": "Get and set user configuration values", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.config.ConfigCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "get", "fullName": "config get", "description": "Display user configuration value", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.config. [...] - { "name": "debug", "fullName": "debug", "description": "Debug local Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Debug", "options": [ { "names": "--ago", "description": "Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp.", "javaType": "boolean", "type": "boolean" }, { "names": "--background", "description": "Run in the background", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "--background-wait", "description": "To [...] - { "name": "dependency", "fullName": "dependency", "description": "Displays all Camel dependencies required to run", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.DependencyCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "copy", "fullName": "dependency copy", "description": "Copies all Camel dependencies required to run to a specific directory", "sourc [...] + { "name": "debug", "fullName": "debug", "description": "Debug local Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Debug", "options": [ { "names": "--ago", "description": "Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp.", "javaType": "boolean", "type": "boolean" }, { "names": "--background", "description": "Run in the background", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "--background-wait", "description": "To [...] + { "name": "dependency", "fullName": "dependency", "description": "Displays all Camel dependencies required to run", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.DependencyCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "copy", "fullName": "dependency copy", "description": "Copies all Camel dependencies required to run to a specific directory", "sourc [...] { "name": "dirty", "fullName": "dirty", "description": "Check if there are dirty files from previous Camel runs that did not terminate gracefully", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.Dirty", "options": [ { "names": "--clean", "description": "Clean dirty files which are no longer in use", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", " [...] { "name": "doc", "fullName": "doc", "description": "Shows documentation for kamelet, component, and other Camel resources", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.catalog.CatalogDoc", "options": [ { "names": "--camel-version", "description": "To use a different Camel version than the default version", "javaType": "java.lang.String", "type": "string" }, { "names": "--download", "description": "Whether to allow automatic downloading JAR dependencies (over the internet [...] - { "name": "export", "fullName": "export", "description": "Export to other runtimes (Camel Main, Spring Boot, or Quarkus)", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Export", "options": [ { "names": "--build-property", "description": "Maven\/Gradle build properties, ex. --build-property=prop1=foo", "javaType": "java.util.List", "type": "array" }, { "names": "--build-tool", "description": "DEPRECATED: Build tool to use (maven or gradle) (gradle is deprecated)", "defaultV [...] - { "name": "get", "fullName": "get", "description": "Get status of Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.CamelStatus", "options": [ { "names": "--watch", "description": "Execute periodically and showing output fullscreen", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "bean", "fullName": "get [...] + { "name": "export", "fullName": "export", "description": "Export to other runtimes (Camel Main, Spring Boot, or Quarkus)", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Export", "options": [ { "names": "--build-property", "description": "Maven\/Gradle build properties, ex. --build-property=prop1=foo", "javaType": "java.util.List", "type": "array" }, { "names": "--build-tool", "description": "DEPRECATED: Build tool to use (maven or gradle) (gradle is deprecated)", "defaultV [...] + { "name": "get", "fullName": "get", "description": "Get status of Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.CamelStatus", "options": [ { "names": "--watch", "description": "Execute periodically and showing output fullscreen", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "bean", "fullName": "get [...] { "name": "hawtio", "fullName": "hawtio", "description": "Launch Hawtio web console", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.Hawtio", "options": [ { "names": "--openUrl", "description": "To automatic open Hawtio web console in the web browser", "defaultValue": "true", "javaType": "boolean", "type": "boolean" }, { "names": "--port", "description": "Port number to use for Hawtio web console (port 8888 by default)", "defaultValue": "8888", "javaType": "int", "t [...] { "name": "infra", "fullName": "infra", "description": "List and Run external services for testing and prototyping", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.infra.InfraCommand", "options": [ { "names": "--json", "description": "Output in JSON Format", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "get", "fullName": "infra [...] { "name": "init", "fullName": "init", "description": "Creates a new Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Init", "options": [ { "names": "--clean-dir,--clean-directory", "description": "Whether to clean directory first (deletes all files in directory)", "javaType": "boolean", "type": "boolean" }, { "names": "--dir,--directory", "description": "Directory relative path where the new Camel integration will be saved", "defaultValue": ".", "javaType" [...] @@ -19,13 +19,13 @@ { "name": "nano", "fullName": "nano", "description": "Nano editor to edit file", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Nano", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ] }, { "name": "plugin", "fullName": "plugin", "description": "Manage plugins that add sub-commands to this CLI", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.plugin.PluginCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "add", "fullName": "plugin add", "description": "Add new plugin", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.plugin.PluginA [...] { "name": "ps", "fullName": "ps", "description": "List running Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.ListProcess", "options": [ { "names": "--json", "description": "Output in JSON Format", "javaType": "boolean", "type": "boolean" }, { "names": "--pid", "description": "List only pid in the output", "javaType": "boolean", "type": "boolean" }, { "names": "--remote", "description": "Break down counters into remote\/total pairs", "javaType": [...] - { "name": "run", "fullName": "run", "description": "Run as local Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Run", "options": [ { "names": "--background", "description": "Run in the background", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "--background-wait", "description": "To wait for run in background to startup successfully, before returning", "defaultValue": "true", "javaType": "boolean", "type": "boolean" }, { [...] - { "name": "sbom", "fullName": "sbom", "description": "Generate a CycloneDX or SPDX SBOM for a specific project", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.SBOMGenerator", "options": [ { "names": "--build-property", "description": "Maven\/Gradle build properties, ex. --build-property=prop1=foo", "javaType": "java.util.List", "type": "array" }, { "names": "--build-tool", "description": "DEPRECATED: Build tool to use (maven or gradle) (gradle is deprecated)", "defaultValu [...] + { "name": "run", "fullName": "run", "description": "Run as local Camel integration", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Run", "options": [ { "names": "--background", "description": "Run in the background", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "--background-wait", "description": "To wait for run in background to startup successfully, before returning", "defaultValue": "true", "javaType": "boolean", "type": "boolean" }, { [...] + { "name": "sbom", "fullName": "sbom", "description": "Generate a CycloneDX or SPDX SBOM for a specific project", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.SBOMGenerator", "options": [ { "names": "--build-property", "description": "Maven\/Gradle build properties, ex. --build-property=prop1=foo", "javaType": "java.util.List", "type": "array" }, { "names": "--build-tool", "description": "DEPRECATED: Build tool to use (maven or gradle) (gradle is deprecated)", "defaultValu [...] { "name": "script", "fullName": "script", "description": "Run Camel integration as shell script for terminal scripting", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Script", "options": [ { "names": "--logging", "description": "Can be used to turn on logging (logs to file in <user home>\/.camel directory)", "defaultValue": "false", "javaType": "boolean", "type": "boolean" }, { "names": "--logging-level", "description": "Logging level ()", "defaultValue": "info", "javaType [...] { "name": "shell", "fullName": "shell", "description": "Interactive Camel JBang shell.", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.Shell", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ] }, { "name": "stop", "fullName": "stop", "description": "Shuts down running Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.StopProcess", "options": [ { "names": "--kill", "description": "To force killing the process (SIGKILL)", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ] }, { "name": "top", "fullName": "top", "description": "Top status of Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.process.CamelTop", "options": [ { "names": "--watch", "description": "Execute periodically and showing output fullscreen", "javaType": "boolean", "type": "boolean" }, { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "context", "fullName": "top [...] - { "name": "trace", "fullName": "trace", "description": "Tail message traces from running Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.action.CamelTraceAction", "options": [ { "names": "--action", "description": "Action to start, stop, clear, list status, or dump traces", "defaultValue": "status", "javaType": "java.lang.String", "type": "string" }, { "names": "--ago", "description": "Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp.", "javaType": "b [...] + { "name": "trace", "fullName": "trace", "description": "Tail message traces from running Camel integrations", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.action.CamelTraceAction", "options": [ { "names": "--action", "description": "Action to start, stop, clear, list status, or dump traces", "defaultValue": "status", "javaType": "java.lang.String", "type": "string" }, { "names": "--ago", "description": "Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp.", "javaType": "b [...] { "name": "transform", "fullName": "transform", "description": "Transform message or Camel routes", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.TransformCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "message", "fullName": "transform message", "description": "Transform message from one format to another via an existing running Camel integration", " [...] { "name": "update", "fullName": "update", "description": "Update Camel project", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.update.UpdateCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "list", "fullName": "update list", "description": "List available update versions for Camel and its runtime variants", "sourceClass": "org.apache.camel.dsl.jbang.cor [...] { "name": "version", "fullName": "version", "description": "Manage Camel versions", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.version.VersionCommand", "options": [ { "names": "-h,--help", "description": "Display the help and sub-commands", "javaType": "boolean", "type": "boolean" } ], "subcommands": [ { "name": "get", "fullName": "version get", "description": "Displays current Camel version", "sourceClass": "org.apache.camel.dsl.jbang.core.commands.version.VersionGet", [...] diff --git a/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JBangCommandModel.java b/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JBangCommandModel.java index 6a1bc335b7a6..6ed524799f96 100644 --- a/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JBangCommandModel.java +++ b/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JBangCommandModel.java @@ -45,6 +45,7 @@ public class JBangCommandModel { private boolean deprecated; private String deprecationNote; private String sourceClass; + private String examples; private final List<JBangCommandOption> options = new ArrayList<>(); private final List<JBangCommand> subcommands = new ArrayList<>(); @@ -104,6 +105,18 @@ public class JBangCommandModel { this.sourceClass = sourceClass; } + public String getExamples() { + return examples; + } + + public void setExamples(String examples) { + this.examples = examples; + } + + public boolean hasExamples() { + return examples != null && !examples.isBlank(); + } + public List<JBangCommandOption> getOptions() { return options; } diff --git a/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JsonMapper.java b/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JsonMapper.java index a36702c5a827..9f117dafa52e 100644 --- a/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JsonMapper.java +++ b/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/JsonMapper.java @@ -980,6 +980,7 @@ public final class JsonMapper { command.setDeprecated(obj.getBooleanOrDefault("deprecated", false)); command.setDeprecationNote(obj.getString("deprecationNote")); command.setSourceClass(obj.getString("sourceClass")); + command.setExamples(obj.getString("examples")); JsonArray options = (JsonArray) obj.get("options"); if (options != null) { @@ -1046,6 +1047,9 @@ public final class JsonMapper { if (cmd.getSourceClass() != null) { json.put("sourceClass", cmd.getSourceClass()); } + if (cmd.getExamples() != null) { + json.put("examples", cmd.getExamples()); + } if (cmd.hasOptions()) { JsonArray options = new JsonArray(); diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsDocMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsDocMojo.java index a36f90c51bc1..d6d5e6a7925a 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsDocMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsDocMojo.java @@ -171,6 +171,12 @@ public class PrepareCamelJBangCommandsDocMojo extends AbstractGeneratorMojo { Map<String, Object> ctx = new HashMap<>(); ctx.put("command", cmd); + // Check if an examples file exists for this command + String examplesFileName = getExamplesFileName(cmd); + Path examplesFile = docDir.toPath().resolve("jbang-commands/examples/" + examplesFileName); + ctx.put("hasExamplesFile", Files.exists(examplesFile)); + ctx.put("examplesFileName", examplesFileName); + String content = (String) TemplateRuntime.eval(template, ctx, Collections.singletonMap("util", MvelHelper.INSTANCE)); @@ -181,4 +187,13 @@ public class PrepareCamelJBangCommandsDocMojo extends AbstractGeneratorMojo { throw new MojoExecutionException("Error generating command page for " + cmd.getName(), e); } } + + /** + * Gets the examples file name for a command. For example, "run" -> "run.adoc", "catalog component" -> + * "catalog-component.adoc" + */ + private String getExamplesFileName(JBangCommand cmd) { + String fullName = cmd.getFullName() != null ? cmd.getFullName() : cmd.getName(); + return fullName.replace(" ", "-") + ".adoc"; + } } diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsMojo.java index de9fbc4cf887..2ee57c6e16ee 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCamelJBangCommandsMojo.java @@ -528,6 +528,8 @@ public class PrepareCamelJBangCommandsMojo extends AbstractGeneratorMojo { description = description.replace("(${COMPLETION-CANDIDATES})", ""); // Remove ${camel-version} and similar version placeholders description = description.replaceAll("\\$\\{[^}]+\\}", ""); + // Remove Java string concatenation artifacts (+ at end of line from multi-line strings) + description = description.replaceAll("\\s*\\+\\s*", " "); // Clean up any resulting double spaces description = description.replaceAll("\\s+", " ").trim(); return description; diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/jbang-command-page.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/jbang-command-page.mvel index 5d5af73b968a..57ccae22061d 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/jbang-command-page.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/jbang-command-page.mvel @@ -49,3 +49,7 @@ camel @{command.fullName} [options] @foreach{opt : command.options}| `@{opt.names}`@if{opt.deprecated} _(deprecated)_@end{} | @if{opt.description != null}@{util.escape(opt.description)}@end{} | @{opt.shortDefaultValue} | @{opt.shortJavaType} @end{}|=== @end{} +@if{hasExamplesFile} + +include::examples/@{examplesFileName}[] +@end{}
