This is an automated email from the ASF dual-hosted git repository.
astefanutti pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 82e2a0c76798a1ade14fb718e639a27e3db2318f
Author: Antonin Stefanutti <anto...@stefanutti.fr>
AuthorDate: Thu Feb 4 13:55:16 2021 +0100
chore(doc): Polish Kamel CLI doc
---
docs/modules/ROOT/pages/cli/cli.adoc | 51 +++++++++++++++++++-----------------
1 file changed, 27 insertions(+), 24 deletions(-)
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc
b/docs/modules/ROOT/pages/cli/cli.adoc
index 1d40db3..34a2b2e 100644
--- a/docs/modules/ROOT/pages/cli/cli.adoc
+++ b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -13,81 +13,84 @@ Releases of the Camel K CLI are available on:
Some of the most used commands are:
.Useful Commands
+[cols="1m,2,2m"]
|===
|Name |Description |Example
|help
|Obtain the full list of available commands
-|`kamel help`
+|kamel help
|init
-|Initialize empty Camel K files (besides Java you can also do this for other
languages like Groovy, Kotlin, XML, YMAL)
-|`kamel init Routes.java`
+|Initialize empty Camel K files (besides Java you can also do this for other
languages like Groovy, Kotlin, XML, YAML)
+|kamel init Routes.java
|run
|Run an integration on Kubernetes
-|`kamel run Routes.java`
+|kamel run Routes.java
|debug
|Debug a remote integration using a local debugger
-|`kamel debug myintegration`
+|kamel debug my-integration
|get
|Get integrations deployed on Kubernetes
-|`kamel get`
+|kamel get
|describe
|Get detailed information on a resource
-|`kamel describe integration routes`
+|kamel describe integration routes
|log
|Print the logs of a running integration
-|`kamel log routes`
+|kamel log routes
|delete
|Delete integrations deployed on Kubernetes
-|`kamel delete routes`
+|kamel delete routes
|===
-The list above is not the full list of available commands. You can run `kamel
help` to obtain the full list.
-And each command also takes `--help` as parameter to output more information,
eg
+The list above is not the full list of available commands.
+You can run `kamel help` to obtain the full list.
+Each command also takes the `--help` as option to output more information,
e.g.:
-[source]
+[source,console]
----
-kamel run --help
+$ kamel run --help
----
== Global Flags
-While each command has a dedicated set of flags, there are global flags that
are available to every command.
+While each command has a dedicated set of flags, there are global flags that
are available to every command:
.Global Flags
+[cols="1,2,2m"]
|===
|Flag |Description |Example
-|`--config` string
+|`--config PATH`
|Path to the config file to use for CLI requests
-|`kamel install --config ~/.kube/config`
+|kamel install --config ~/.kube/config
|`-h` or `--help`
-|Help for kamel or the command
-|`kamel run --help`
+|Help for `kamel`, or the command
+|kamel run --help
-|`-n` or `--namespace` string
+|`-n` or `--namespace NAME`
|Namespace to use for all operations
-|`kamel get --namespace myspace`
+|kamel get --namespace NAME
|===
-For command-specific flags, run `--help` with the command to obtain the full
list as follows:
+For command-specific flags, run `--help` with the command to obtain the full
list, e.g.:
-[source]
+[source,console]
----
-kamel <command> --help
+$ kamel <command> --help
----
== Modeline
-Some command options in the CLI can be also specified as modeline in the
source file, take a look at the xref:cli/modeline.adoc[Modeline section]
+Some command options in the CLI can be also specified as modeline in the
source file, take a look at the xref:cli/modeline.adoc[Modeline] section
for more information.
