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.

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

Docs: add basic documentation for CLI #2101

Merged
merged 1 commit into from
Jun 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
76 changes: 76 additions & 0 deletions docs/common/cli/cli.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020 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.

///////////////////////////////////////////////////////////////////////////////

== 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 download for Linux and Mac.
Simply download the binary, install it at a location accessible from your PATH
and you’re ready to go.

== Installation

[source,bash]
.MacOS
----
curl -O https://helidon.io/cli/latest/darwin/helidon
chmod +x ./helidon
sudo mv ./helidon /usr/local/bin/
----

[source,bash]
.Linux
----
curl -O https://helidon.io/cli/latest/linux/helidon
chmod +x ./helidon
sudo mv ./helidon /usr/local/bin/
----

Windows builds to come.


== 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"]

Binary file added docs/images/cli/Helidon_cli.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/mp/cli/01_cli.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020 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
:h1Prefix: MP
:description: Helidon CLI
:keywords: helidon cli

The Helidon CLI enables developers to get started with Helidon with minimal
effort: you can create a new application, build it, run it, and more, by
running some simple commands.

include::../../common/cli/cli.adoc[]

29 changes: 29 additions & 0 deletions docs/se/cli/01_cli.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020 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
:h1Prefix: SE
:description: Helidon CLI
:keywords: helidon cli

The Helidon CLI enables developers to get started with Helidon with minimal
effort: you can create a new application, build it, run it, and more, by
running some simple commands.

include::../../common/cli/cli.adoc[]

16 changes: 16 additions & 0 deletions docs/sitegen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,14 @@ backend:
items:
- includes:
- "se/guides/*.adoc"
- title: "CLI"
pathprefix: "/se/cli"
glyph:
type: "icon"
value: "computer"
items:
- includes:
- "se/cli/*.adoc"
- title: "Config"
pathprefix: "/se/config"
glyph:
Expand Down Expand Up @@ -227,6 +235,14 @@ backend:
items:
- includes:
- "mp/guides/*.adoc"
- title: "CLI"
pathprefix: "/mp/cli"
glyph:
type: "icon"
value: "computer"
items:
- includes:
- "mp/cli/*.adoc"
- title: "Config"
pathprefix: "/mp/config"
glyph:
Expand Down