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
The following commit(s) were added to refs/heads/master by this push:
new 5155bcd doc(cli): add section for global flags #1185
5155bcd is described below
commit 5155bcd2ceaf8d037e5977e1dfb0c5adf5c475a3
Author: Tadayoshi Sato <[email protected]>
AuthorDate: Mon Nov 30 15:16:48 2020 +0900
doc(cli): add section for global flags #1185
---
docs/modules/ROOT/pages/cli/cli.adoc | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc
b/docs/modules/ROOT/pages/cli/cli.adoc
index 26d220b..1d40db3 100644
--- a/docs/modules/ROOT/pages/cli/cli.adoc
+++ b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -58,6 +58,35 @@ And each command also takes `--help` as parameter to output
more information, eg
kamel run --help
----
+== Global Flags
+
+While each command has a dedicated set of flags, there are global flags that
are available to every command.
+
+.Global Flags
+|===
+|Flag |Description |Example
+
+|`--config` string
+|Path to the config file to use for CLI requests
+|`kamel install --config ~/.kube/config`
+
+|`-h` or `--help`
+|Help for kamel or the command
+|`kamel run --help`
+
+|`-n` or `--namespace` string
+|Namespace to use for all operations
+|`kamel get --namespace myspace`
+
+|===
+
+For command-specific flags, run `--help` with the command to obtain the full
list as follows:
+
+[source]
+----
+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]
