Skip to content

Commit

Permalink
Command mode apps - fix the restart key in the docs
Browse files Browse the repository at this point in the history
- also mention the dev mode in the picocli guide
  • Loading branch information
mkouba committed Aug 9, 2021
1 parent 086885f commit 6b5ec2e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/command-mode-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ in order to unblock the main thread and initiate the shutdown process.

=== Dev mode

Also for command mode applications the dev mode is supported. When running `mvn compile quarkus:dev`, the command mode application is executed and on press of the Enter key, is restarted.
Also for command mode applications the dev mode is supported. When running `mvn compile quarkus:dev`, the command mode application is executed and on press of the `Space bar` key, is restarted.

As command mode applications will often require arguments to be passed on the commandline, this is also possible in dev mode via:

Expand Down
4 changes: 4 additions & 0 deletions docs/src/main/asciidoc/picocli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,10 @@ annotationProcessor enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatfor
annotationProcessor 'info.picocli:picocli-codegen'
----

== Development Mode

In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`.

== Configuration Reference

include::{generated-dir}/config/quarkus-picocli.adoc[opts=optional, leveloffset=+1]

0 comments on commit 6b5ec2e

Please sign in to comment.