Skip to content

Commit

Permalink
doc(cli): add section for global flags #1185
Browse files Browse the repository at this point in the history
  • Loading branch information
tadayosi authored and astefanutti committed Nov 30, 2020
1 parent 2b9cd3e commit 5155bcd
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/modules/ROOT/pages/cli/cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 5155bcd

Please sign in to comment.