Skip to content

Commit

Permalink
Update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@aalmiray
aalmiray committed Jan 10, 2025
1 parent e8bc76d commit 39a8160
Showing 1 changed file with 164 additions and 150 deletions.
314 changes: 164 additions & 150 deletions docs/modules/ROOT/pages/install.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,167 +5,20 @@ There are multiple choices depending on your preference.
== CLI
The xref:tools:jreleaser-cli.adoc[CLI] can be installed in the following ways:

=== Early Access

[tabs]
====
Windows::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-windows-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-*-windows-x86_64.zip` does not require Java.
--
Linux::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*Curl*
Requires Java 11
[source]
----
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-windows-*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-early-access-windows-x86_64.zip` does not require Java.
--
Mac::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*Curl*
Requires Java 11
[source]
----
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
----
*Dagger*
Head to the documentation page of the
link:https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/alpha/jreleaser[universe.dagger.io/alpha/jreleaser]
package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-osx-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-early-access-osx-*.zip` does not require Java.
--
====

=== Stable

[tabs]
====
Windows::
Linux::
+
--
*Sdkman*
*Setup script*
Requires Java 8
[source]
----
sdk install jreleaser
curl https://jreleaser.org/setup.sh -sSfL | sh
----
*Scoop*:
Requires Java 8
[source]
----
scoop bucket add jreleaser https://github.com/jreleaser/scoop-jreleaser.git
scoop install jreleaser
----
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser@jreleaser <command> [<args>]
----
*Chocolatey*
Requires Java 8
[source]
----
choco install jreleaser
----
*Winget*
[source]
----
winget install jreleaser
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
`jreleaser-standalone-{jreleaser-version}-windows-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-windows-*.zip` does not require Java.
--
Linux::
+
--
*Sdkman*
Requires Java 8
Expand Down Expand Up @@ -272,6 +125,13 @@ it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-linux-*.
Mac::
+
--
*Setup script*
[source]
----
curl https://jreleaser.org/setup.sh -sSfL | sh
----
*Sdkman*
Requires Java 8
Expand Down Expand Up @@ -340,6 +200,160 @@ NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be
`jreleaser-standalone-{jreleaser-version}-osx-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-osx-*.zip` does not require Java.
--
Windows::
+
--
*Sdkman*
Requires Java 8
[source]
----
sdk install jreleaser
----
*Scoop*:
Requires Java 8
[source]
----
scoop bucket add jreleaser https://github.com/jreleaser/scoop-jreleaser.git
scoop install jreleaser
----
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser@jreleaser <command> [<args>]
----
*Chocolatey*
Requires Java 8
[source]
----
choco install jreleaser
----
*Winget*
[source]
----
winget install jreleaser
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
`jreleaser-standalone-{jreleaser-version}-windows-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-windows-*.zip` does not require Java.
--
====

=== Early Access

[tabs]
====
Linux::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*Curl*
Requires Java 11
[source]
----
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-windows-*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-early-access-windows-x86_64.zip` does not require Java.
--
Mac::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*Curl*
Requires Java 11
[source]
----
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
----
*Dagger*
Head to the documentation page of the
link:https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/alpha/jreleaser[universe.dagger.io/alpha/jreleaser]
package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-osx-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-early-access-osx-*.zip` does not require Java.
--
Windows::
+
--
*JBang*
[source]
----
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
`jreleaser-standalone-early-access-windows-\*.zip` can be used without a previous installation of Java as
it includes its own Java Runtime. `jreleaser-native-*-windows-x86_64.zip` does not require Java.
--
====

== Docker
Expand Down

0 comments on commit 39a8160

Please sign in to comment.