Skip to content

Commit

Permalink
Update command-mode-reference.adoc
Browse files Browse the repository at this point in the history
I missed the instructions on how to launch the app.

Advantages of putting them in:
- People using this article have all the information they need, and don't need to try searching in their `target` folder to figure out the right invocation

Disadvantages of putting the commands in:
- The information is available elsewhere, so this is duplication
- The information isn't 'unique' to command mode

WDYT?
  • Loading branch information
holly-cummins committed Jun 24, 2024
1 parent 2f41fac commit 710edd8
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/src/main/asciidoc/command-mode-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,24 @@ thread (A non-command mode application is essentially just running an applicatio
If you want to shut down a running application and you are not in the main thread, then you should call `Quarkus.asyncExit`
in order to unblock the main thread and initiate the shutdown process.

=== Running the application

To run the command mode application on the JVM, first build it using `mvnw package` or equivalent.

Then launch it:

Check warning on line 144 in docs/src/main/asciidoc/command-mode-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsWarnings] Consider using 'start' or 'open' rather than 'launch' unless updating existing content that uses the term. Raw Output: {"message": "[Quarkus.TermsWarnings] Consider using 'start' or 'open' rather than 'launch' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/command-mode-reference.adoc", "range": {"start": {"line": 144, "column": 6}}}, "severity": "WARNING"}

[source,shell]
----
java -jar target/quarkus-app/quarkus-run.jar
----

You can also build a native application with `mvnw package -Dnative`, and launch it with something like:

Check warning on line 151 in docs/src/main/asciidoc/command-mode-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsWarnings] Consider using 'start' or 'open' rather than 'launch' unless updating existing content that uses the term. Raw Output: {"message": "[Quarkus.TermsWarnings] Consider using 'start' or 'open' rather than 'launch' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/command-mode-reference.adoc", "range": {"start": {"line": 151, "column": 75}}}, "severity": "WARNING"}

[source,shell]
----
./target/getting-started-command-mode-1.0-SNAPSHOT-runner
----

=== Development Mode

Check warning on line 158 in docs/src/main/asciidoc/command-mode-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.Headings] Use sentence-style capitalization in 'Development Mode'. Raw Output: {"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Development Mode'.", "location": {"path": "docs/src/main/asciidoc/command-mode-reference.adoc", "range": {"start": {"line": 158, "column": 5}}}, "severity": "INFO"}

Also, for command mode applications, the dev mode is supported.
Expand Down

0 comments on commit 710edd8

Please sign in to comment.