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

Add launch instructions to command mode guide #41363

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Add launch instructions to command mode guide #41363

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
18 changes: 18 additions & 0 deletions docs/src/main/asciidoc/command-mode-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,25 @@
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.
When you start your application in dev mode, the command mode application is executed:
Expand Down