about.cli.adoc Maven / Gradle / Ivy
The newest version!
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2020, 2024 Oracle and/or its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
///////////////////////////////////////////////////////////////////////////////
= Helidon CLI
:description: Helidon CLI
:keywords: helidon cli
:rootdir: {docdir}/..
include::{rootdir}/includes/attributes.adoc[]
== Introduction
The Helidon CLI lets you easily create a Helidon project by picking from 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.
The CLI is distributed as a standalone executable (compiled using GraalVM) for
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
.Prerequisite product versions for Helidon {helidon-version}
[%autowidth]
|=======
include::{rootdir}/includes/prerequisites.adoc[tag=prerequisites-table-rows-core]
|=======
You should make sure `java` and `mvn` are in your path.
[source,bash]
----
java -version
mvn --version
----
== Installation
[source,bash]
.MacOS
----
curl -L -O https://helidon.io/cli/latest/darwin/helidon
chmod +x ./helidon
sudo mv ./helidon /usr/local/bin/
----
If you get a warning that "the developer cannot be verified" when running the CLI
this is due to the Helidon CLI not being signed and notarized yet. You can disable
this check by running: `xattr -d com.apple.quarantine helidon`
[source,bash]
.Linux
----
curl -L -O https://helidon.io/cli/latest/linux/helidon
chmod +x ./helidon
sudo mv ./helidon /usr/local/bin/
----
[source,powershell]
.Windows
----
PowerShell -Command Invoke-WebRequest -Uri "https://helidon.io/cli/latest/windows/helidon.exe" -OutFile "C:\Windows\system32\helidon.exe"
----
For Windows you will also need the Visual C++ Redistributable Runtime. See xref:windows.adoc[Helidon on Windows]
for more information.
[source,bash]
.Verify CLI installation
----
helidon version
----
== Create a New Project
[source,bash]
----
helidon init
----
Then answer the questions.
== Developer Loop
[source,bash]
----
cd myproject
helidon dev
----
As you make source code changes the project will automatically recompile and restart your
application.
== Demo
image::cli/Helidon_cli.gif[CLI Demo, align="center"]