Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(cli): add section for global flags #1185 #1833

Merged
merged 1 commit into from
Nov 30, 2020
Merged

doc(cli): add section for global flags #1185 #1833

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/modules/ROOT/pages/cli/cli.adoc
View file
Open in desktop
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