diff --git a/docs/common/cli/cli.adoc b/docs/common/cli/cli.adoc new file mode 100644 index 00000000000..e1d8a5c619c --- /dev/null +++ b/docs/common/cli/cli.adoc @@ -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"] + diff --git a/docs/images/cli/Helidon_cli.gif b/docs/images/cli/Helidon_cli.gif new file mode 100644 index 00000000000..2b63550a3cc Binary files /dev/null and b/docs/images/cli/Helidon_cli.gif differ diff --git a/docs/mp/cli/01_cli.adoc b/docs/mp/cli/01_cli.adoc new file mode 100644 index 00000000000..a073775f916 --- /dev/null +++ b/docs/mp/cli/01_cli.adoc @@ -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[] + diff --git a/docs/se/cli/01_cli.adoc b/docs/se/cli/01_cli.adoc new file mode 100644 index 00000000000..c10fa21128b --- /dev/null +++ b/docs/se/cli/01_cli.adoc @@ -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[] + diff --git a/docs/sitegen.yaml b/docs/sitegen.yaml index 59859ec52a0..efde7f226c2 100644 --- a/docs/sitegen.yaml +++ b/docs/sitegen.yaml @@ -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: @@ -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: