camel doc

Shows documentation for kamelet, component, and other Camel resources

Usage

camel doc [options]

Options

Option Description Default Type

--camel-version

To use a different Camel version than the default version

String

--download

Whether to allow automatic downloading JAR dependencies (over the internet)

true

boolean

--example

Prints a minimal working YAML route snippet for the component

false

boolean

--filter

Filter option listed in tables by name, description, or group

String

--fresh

Make sure we use fresh (i.e. non-cached) resources

false

boolean

--header

Whether to display component message headers

false

boolean

--kamelets-version

Apache Camel Kamelets version

RuntimeType.KAMELETS_VERSION

String

--open-url

Opens the online documentation form the Camel website in the web browser

false

boolean

--quarkus-artifact-id (deprecated)

Deprecated. This value is not used anymore. It is kept only for backwards compatibility and will be removed in Camel 5.x. Camel commands may use either 'quarkus-bom' or 'quarkus-camel-bom' artifactIds depending on the context.

quarkus-bom

String

--quarkus-ext-registry

The base URI of Quarkus Extension Registry. The default is {@value RuntimeType#QUARKUS_EXTENSION_REGISTRY_BASE_URL} unless camel.jbang.quarkus.platform.url system property is set (the /client/platforms suffix is removed if present).

String

--quarkus-group-id

groupId of Quarkus Platform BOM; honored only if --quarkus-version is set

io.quarkus.platform

String

--quarkus-version

version of Quarkus Platform BOM; the default value is looked up in Quarkus Extension Registry

String

--repo,--repos

Additional maven repositories for download on-demand (Use commas to separate multiple repositories)

String

--runtime

Runtime (camel-main, spring-boot, quarkus)

RuntimeType

--url

Prints the link to the online documentation on the Camel website

false

boolean

-h,--help

Display the help and sub-commands

boolean