Skip to content

Commit 39a8160

Browse files
aalmirayaalmiray
committed
Update install instructions
1 parent e8bc76d commit 39a8160

File tree

1 file changed

+164
-150
lines changed

1 file changed

+164
-150
lines changed

‎docs/modules/ROOT/pages/install.adoc‎

Lines changed: 164 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -5,167 +5,20 @@ There are multiple choices depending on your preference.
55
== CLI
66
The xref:tools:jreleaser-cli.adoc[CLI] can be installed in the following ways:
77

8-
=== Early Access
9-
10-
[tabs]
11-
====
12-
Windows::
13-
+
14-
--
15-
*JBang*
16-
17-
[source]
18-
----
19-
// Download, cache, and run
20-
jbang jreleaser-snapshot@jreleaser <command> [<args>]
21-
----
22-
23-
*manually*
24-
25-
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
26-
uncompress and copy to the desired location.
27-
28-
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
29-
`jreleaser-standalone-early-access-windows-\*.zip` can be used without a previous installation of Java as
30-
it includes its own Java Runtime. `jreleaser-native-*-windows-x86_64.zip` does not require Java.
31-
--
32-
Linux::
33-
+
34-
--
35-
*JBang*
36-
37-
[source]
38-
----
39-
// Download, cache, and run
40-
jbang jreleaser-snapshot@jreleaser <command> [<args>]
41-
----
42-
43-
*Curl*
44-
45-
Requires Java 11
46-
[source]
47-
----
48-
// Get the jreleaser downloader
49-
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
50-
51-
// Download JReleaser with version = early-access
52-
java get_jreleaser.java early-access
53-
54-
// Execute JReleaser
55-
java -jar jreleaser-cli.jar <command> [<args>]
56-
----
57-
58-
*manually*
59-
60-
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
61-
uncompress and copy to the desired location.
62-
63-
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
64-
`jreleaser-standalone-early-access-windows-*.zip` can be used without a previous installation of Java as
65-
it includes its own Java Runtime. `jreleaser-native-early-access-windows-x86_64.zip` does not require Java.
66-
--
67-
Mac::
68-
+
69-
--
70-
*JBang*
71-
72-
[source]
73-
----
74-
// Download, cache, and run
75-
jbang jreleaser-snapshot@jreleaser <command> [<args>]
76-
----
77-
78-
*Curl*
79-
80-
Requires Java 11
81-
[source]
82-
----
83-
// Get the jreleaser downloader
84-
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
85-
86-
// Download JReleaser with version = early-access
87-
java get_jreleaser.java early-access
88-
89-
// Execute JReleaser
90-
java -jar jreleaser-cli.jar <command> [<args>]
91-
----
92-
93-
*Dagger*
94-
95-
Head to the documentation page of the
96-
link:https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/alpha/jreleaser[universe.dagger.io/alpha/jreleaser]
97-
package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
98-
99-
*manually*
100-
101-
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
102-
uncompress and copy to the desired location.
103-
104-
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
105-
`jreleaser-standalone-early-access-osx-\*.zip` can be used without a previous installation of Java as
106-
it includes its own Java Runtime. `jreleaser-native-early-access-osx-*.zip` does not require Java.
107-
--
108-
====
109-
1108
=== Stable
1119

11210
[tabs]
11311
====
114-
Windows::
12+
Linux::
11513
+
11614
--
117-
*Sdkman*
15+
*Setup script*
11816
119-
Requires Java 8
12017
[source]
12118
----
122-
sdk install jreleaser
19+
curl https://jreleaser.org/setup.sh -sSfL | sh
12320
----
12421
125-
*Scoop*:
126-
127-
Requires Java 8
128-
[source]
129-
----
130-
scoop bucket add jreleaser https://github.com/jreleaser/scoop-jreleaser.git
131-
scoop install jreleaser
132-
----
133-
134-
*JBang*
135-
136-
[source]
137-
----
138-
// Download, cache, and run
139-
jbang jreleaser@jreleaser <command> [<args>]
140-
----
141-
142-
*Chocolatey*
143-
144-
Requires Java 8
145-
[source]
146-
----
147-
choco install jreleaser
148-
----
149-
150-
*Winget*
151-
152-
[source]
153-
----
154-
winget install jreleaser
155-
----
156-
157-
*manually*
158-
159-
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
160-
uncompress and copy to the desired location.
161-
162-
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
163-
`jreleaser-standalone-{jreleaser-version}-windows-\*.zip` can be used without a previous installation of Java as
164-
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-windows-*.zip` does not require Java.
165-
--
166-
Linux::
167-
+
168-
--
16922
*Sdkman*
17023
17124
Requires Java 8
@@ -272,6 +125,13 @@ it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-linux-*.
272125
Mac::
273126
+
274127
--
128+
*Setup script*
129+
130+
[source]
131+
----
132+
curl https://jreleaser.org/setup.sh -sSfL | sh
133+
----
134+
275135
*Sdkman*
276136
277137
Requires Java 8
@@ -340,6 +200,160 @@ NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be
340200
`jreleaser-standalone-{jreleaser-version}-osx-\*.zip` can be used without a previous installation of Java as
341201
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-osx-*.zip` does not require Java.
342202
--
203+
Windows::
204+
+
205+
--
206+
*Sdkman*
207+
208+
Requires Java 8
209+
[source]
210+
----
211+
sdk install jreleaser
212+
----
213+
214+
*Scoop*:
215+
216+
Requires Java 8
217+
[source]
218+
----
219+
scoop bucket add jreleaser https://github.com/jreleaser/scoop-jreleaser.git
220+
scoop install jreleaser
221+
----
222+
223+
*JBang*
224+
225+
[source]
226+
----
227+
// Download, cache, and run
228+
jbang jreleaser@jreleaser <command> [<args>]
229+
----
230+
231+
*Chocolatey*
232+
233+
Requires Java 8
234+
[source]
235+
----
236+
choco install jreleaser
237+
----
238+
239+
*Winget*
240+
241+
[source]
242+
----
243+
winget install jreleaser
244+
----
245+
246+
*manually*
247+
248+
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
249+
uncompress and copy to the desired location.
250+
251+
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
252+
`jreleaser-standalone-{jreleaser-version}-windows-\*.zip` can be used without a previous installation of Java as
253+
it includes its own Java Runtime. `jreleaser-native-{jreleaser-version}-windows-*.zip` does not require Java.
254+
--
255+
====
256+
257+
=== Early Access
258+
259+
[tabs]
260+
====
261+
Linux::
262+
+
263+
--
264+
*JBang*
265+
266+
[source]
267+
----
268+
// Download, cache, and run
269+
jbang jreleaser-snapshot@jreleaser <command> [<args>]
270+
----
271+
272+
*Curl*
273+
274+
Requires Java 11
275+
[source]
276+
----
277+
// Get the jreleaser downloader
278+
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
279+
280+
// Download JReleaser with version = early-access
281+
java get_jreleaser.java early-access
282+
283+
// Execute JReleaser
284+
java -jar jreleaser-cli.jar <command> [<args>]
285+
----
286+
287+
*manually*
288+
289+
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
290+
uncompress and copy to the desired location.
291+
292+
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
293+
`jreleaser-standalone-early-access-windows-*.zip` can be used without a previous installation of Java as
294+
it includes its own Java Runtime. `jreleaser-native-early-access-windows-x86_64.zip` does not require Java.
295+
--
296+
Mac::
297+
+
298+
--
299+
*JBang*
300+
301+
[source]
302+
----
303+
// Download, cache, and run
304+
jbang jreleaser-snapshot@jreleaser <command> [<args>]
305+
----
306+
307+
*Curl*
308+
309+
Requires Java 11
310+
[source]
311+
----
312+
// Get the jreleaser downloader
313+
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
314+
315+
// Download JReleaser with version = early-access
316+
java get_jreleaser.java early-access
317+
318+
// Execute JReleaser
319+
java -jar jreleaser-cli.jar <command> [<args>]
320+
----
321+
322+
*Dagger*
323+
324+
Head to the documentation page of the
325+
link:https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/alpha/jreleaser[universe.dagger.io/alpha/jreleaser]
326+
package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
327+
328+
*manually*
329+
330+
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
331+
uncompress and copy to the desired location.
332+
333+
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
334+
`jreleaser-standalone-early-access-osx-\*.zip` can be used without a previous installation of Java as
335+
it includes its own Java Runtime. `jreleaser-native-early-access-osx-*.zip` does not require Java.
336+
--
337+
Windows::
338+
+
339+
--
340+
*JBang*
341+
342+
[source]
343+
----
344+
// Download, cache, and run
345+
jbang jreleaser-snapshot@jreleaser <command> [<args>]
346+
----
347+
348+
*manually*
349+
350+
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases/tag/early-access[releases page],
351+
uncompress and copy to the desired location.
352+
353+
NOTE: Be mindful that `jreleaser-early-access.zip` requires Java 8 to be installed while
354+
`jreleaser-standalone-early-access-windows-\*.zip` can be used without a previous installation of Java as
355+
it includes its own Java Runtime. `jreleaser-native-*-windows-x86_64.zip` does not require Java.
356+
--
343357
====
344358

345359
== Docker

0 commit comments

Comments
 (0)