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

Jump to bottom

Docs: Add prereqs to CLI page #2958

Merged
merged 2 commits into from
Apr 21, 2021
Merged

Docs: Add prereqs to CLI page #2958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3baf48c
Add prereqs to CLI page
barchetta Apr 20, 2021
2e7f52d
Update HELIDON-CLI.md and README.md with prereq and windows info
barchetta Apr 20, 2021
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
16 changes: 15 additions & 1 deletion HELIDON-CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@ a set of archetypes.
It also supports a developer loop that performs continuous compilation and
application restart, so you can easily iterate over source code changes.

## Prerequisites

Helidon requires Java 11 (or newer) and Maven 3.6.1 or newer.

* [Java SE](https://www.oracle.com/technetwork/java/javase/downloads)
* [Maven](https://maven.apache.org/download.cgi)

You should make sure `java` and `mvn` are in your path.

```bash
java -version
mvn --version
```

## Install

MacOS:
Expand Down Expand Up @@ -49,4 +63,4 @@ restart your application.

<p align="center">
<img src="etc/images/Helidon_cli.gif">
</p>
</p>
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ chmod +x ./helidon
sudo mv ./helidon /usr/local/bin/
```

Windows:
```bat
PowerShell -Command Invoke-WebRequest -Uri "https://helidon.io/cli/latest/windows/helidon.exe" -OutFile "C:\Windows\system32\helidon.exe"
```

See this [document](HELIDON-CLI.md) for more info.

## Build
Expand Down
20 changes: 19 additions & 1 deletion docs/about/05_cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,28 @@ compilation and application restart, so you can easily iterate over source
code changes.

The CLI is distributed as a standalone executable (compiled using GraalVM) for
ease of installation. It is currently available as download for Linux and Mac.
ease of installation. It is currently available as a download for Linux, Mac and Windows.
Simply download the binary, install it at a location accessible from your PATH
and you’re ready to go.

== Prerequisites

Helidon requires Java 11 (or newer) and Maven.

[role="flex, sm7"]
|=======
|https://www.oracle.com/technetwork/java/javase/downloads[Java{nbsp}SE{nbsp}11] (http://jdk.java.net[Open{nbsp}JDK{nbsp}11]) or newer
|https://maven.apache.org/download.cgi[Maven 3.6.1+]
|=======

You should make sure `java` and `mvn` are in your path.

[source,bash]
----
java -version
mvn --version
----

== Installation

[source,bash]
Expand Down