Skip to content

Commit

Permalink
CLI install - Improve things and use tabs
Browse files Browse the repository at this point in the history
(cherry picked from commit 8a9b38d)
  • Loading branch information
gsmet committed Mar 9, 2022
1 parent 3791ec0 commit 17095d2
Showing 1 changed file with 83 additions and 14 deletions.
97 changes: 83 additions & 14 deletions docs/src/main/asciidoc/cli-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,25 @@ include::./status-include.adoc[]

== Installing the CLI

You can install the Quarkus CLI via:
The Quarkus CLI is available in several developer-oriented package managers such as:

* <<jbang,JBang>> for Linux, OSX and Windows (no java required)
* <<sdkman,SDKMAN!>> for Linux and OSX (java required)
* <<homebrew,Homebrew>> for OSX (java required)
* https://sdkman.io[SDKMAN!]
* https://brew.sh[Homebrew]
* https://community.chocolatey.org/packages/quarkus[Chocolatey]

More alternatives such as https://chocolatey.org[Chocolatey] will be made available soon.
If you already use (or want to use) one of these tools, it is the simplest way to install the Quarkus CLI and keep it updated.

In addition to these package managers, the Quarkus CLI is also installable via https://www.jbang.dev[JBang].
Choose the alternative that is the most practical for you:

[[jbang]]
=== Installing with JBang
* JBang - for Linux, macOS and Windows
* SDKMAN! - for Linux and macOS
* Homebrew - for Linux and macOS
* Chocolatey - for Windows

[role="primary asciidoc-tabs-sync-jbang"]
.JBang
****
The Quarkus CLI is available as a jar installable using https://jbang.dev[JBang].
JBang will use your existing Java or install one for you if needed.
Expand Down Expand Up @@ -82,10 +89,11 @@ have a JBang version older than v0.56.0 installed. Please remove or upgrade it t
If you are installing JBang for the first time, start a new session to update your `PATH`.
====
****

[[sdkman]]
=== Installing with SDKMAN!

[role="secondary asciidoc-tabs-sync-sdkman"]
.SDKMAN!
****
https://sdkman.io/[SDKMAN!] can be used to manage development environments.
It can manage parallel versions of multiple Software Development Kits on most Unix based systems,
making it a very good alternative to keep multiple JDK versions handy.
Expand All @@ -95,21 +103,40 @@ With SDKMAN!, you can also install popular Java tools, including the Quarkus CLI
[NOTE]
====
Make sure you have https://sdkman.io/jdks[a JDK installed] before installing the Quarkus CLI.
To list the available versions of Java, use `sdk list java`.
You can then install the version of OpenJDK you want with `sdk install java x.y.z-open`
(or the JDK of another vendor if it is your preference).
====
To install the Quarkus CLI using SDKMAN!, just run:
To install the Quarkus CLI using SDKMAN!, run the following command:
[source,shell]
----
sdk install quarkus
----
It will install the latest version of the Quarkus CLI.
SDKMAN! will let you know when new versions are available so updates will be straightforward.
[[homebrew]]
=== Installing with Homebrew
Once installed `quarkus` will be in your `$PATH` and if you run `quarkus --version` it will print the installed version:
[source,shell,subs=attributes+]
----
quarkus --version
{quarkus-version}
----
SDKMAN! will let you know when new versions are available so updates will be straightforward:
[source,shell]
----
sdk upgrade quarkus
----
****

[role="secondary asciidoc-tabs-sync-homebrew"]
.Homebrew
****
https://brew.sh[Homebrew] is a package manager for macOS (and Linux).
You can use Homebrew to install (and update) the Quarkus CLI.
Expand Down Expand Up @@ -140,6 +167,40 @@ quarkus --version
{quarkus-version}
----
You can upgrade the Quarkus CLI with:
[source,shell]
----
brew update <1>
brew upgrade quarkus <2>
----
<1> Update all package definitions and Homebrew itself
<2> Upgrade Quarkus CLI to the latest version
****

[role="secondary asciidoc-tabs-sync-chocolatey"]
.Chocolatey
****
https://chocolatey.org[Chocolatey] is a package manager for Windows.
You can use Chocolatey to install (and update) the Quarkus CLI.
[NOTE]
====
Make sure you have a JDK installed before installing the Quarkus CLI.
You can install a JDK with `choco install ojdkbuild17` for Java 17 or `choco install ojdkbuild11` for Java 11.
====
To install the Quarkus CLI using Chocolatey, run the following command:
[source,shell]
----
choco install quarkus
----
It will install the latest version of the Quarkus CLI.
Once installed `quarkus` will be in your `$PATH` and if you run `quarkus --version` it will print the installed version:
[source,shell,subs=attributes+]
Expand All @@ -148,6 +209,14 @@ quarkus --version
{quarkus-version}
----
You can upgrade the Quarkus CLI with:
[source,shell]
----
choco upgrade quarkus
----
****

== Using the CLI

Use `--help` to display help information with all the available commands:
Expand Down

0 comments on commit 17095d2

Please sign in to comment.