Skip to content

Commit

Permalink
DOCS-632 Requested link update (hazelcast#364)
Browse files Browse the repository at this point in the history
On investigation, it was decided to introduce conditional text, and only document build from source for pre-release SNAPSHOT CLC
  • Loading branch information
rebekah-lawrence authored Sep 8, 2023
1 parent cd6e0ff commit ab852ba
Showing 1 changed file with 72 additions and 8 deletions.
80 changes: 72 additions & 8 deletions docs/modules/ROOT/pages/install-clc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,69 @@
* Windows installer
* Building from source
ifdef::snapshot[]
[NOTE]
Pre-release versions can only be built from source.

== Build Pre-release from Source

Supported OS:

- Ubuntu 22.04 or later
- MacOS 12 or later
- Windows 10 or later

Requirements:

- Go 1.19 or later
- Git
- For Linux and MacOS, GNU Make
- Command prompt or Windows Powershell
- For Windows, https://github.com/tc-hib/go-winres[go-winres]

To build from source, complete the following steps:

. Clone the source from Git
+
[source,shell]
----
$ git clone https://github.com/hazelcast/hazelcast-commandline-client.git
----

. Navigate to your project
+
[source,shell]
----
$ cd hazelcast-commandline-client
----

. Build the project
+
[source,shell]
----
$ make
----
+
The ``clc``, or ``clc.exe``, binary is created in the ``build`` directory.

. Run the project
+
-- On Linux or MacOS:
+
[source,shell]
----
./build/clc
----
+
-- On Windows:
+
[source,shell]
----
.\build\clc.exe
----

endif::[]
ifndef::snapshot[]
== Installing on macOS

The Hazelcast CLC is supported on macOS 13 or newer versions.
Expand All @@ -17,7 +80,7 @@ The Hazelcast CLC is supported on macOS 13 or newer versions.
====
ZIP (Intel)::
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the AMD compressed file (`hazelcast-clc_v{full-version}_darwin_amd64.zip`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the AMD compressed file (`hazelcast-clc_v{full-version}_darwin_amd64.zip`).
. Download and unzip the file.
. Remove the `clc` binary from quarantine if you get a security warning when running it:
+
Expand All @@ -34,7 +97,7 @@ sudo mv hazelcast-clc_v{full-version}_darwin_amd64/clc /usr/local/bin
ZIP (Apple Silicon)::
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the ARM compressed file (`hazelcast-clc_v{full-version}_darwin_arm64.zip`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the ARM compressed file (`hazelcast-clc_v{full-version}_darwin_arm64.zip`).
. Download and unzip the file.
. Remove the `clc` binary from quarantine if you get a security warning when running it:
+
Expand All @@ -61,7 +124,7 @@ xcode-select --install
+
** https://go.dev/doc/install[Go {go-version}] or newer (check with the `go version` command)
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the compressed source file (`v{full-version}.zip`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the compressed source file (`v{full-version}.zip`).
. Download and unzip the file.
. Change into the `hazelcast-commandline-client-{full-version}` directory.
+
Expand Down Expand Up @@ -101,7 +164,7 @@ The Hazelcast CLC runs on any recent Linux distribution. We test it on Ubuntu 22
====
Tarball (AMD64)::
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the tarball for Linux (`hazelcast-clc_v{full-version}_linux_amd64.tar.gz`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the tarball for Linux (`hazelcast-clc_v{full-version}_linux_amd64.tar.gz`).
. Download and unzip the file.
. Optionally make `clc` available without using its full path. You can do that by moving `clc` to one of the directories in the `$PATH` environment variable. `/usr/local/bin` is a safe choice.
+
Expand All @@ -116,7 +179,7 @@ Build from Source::
** GNU Make (check with the `make --version` command). It is installed by default on most Linux distributions.
** https://go.dev/doc/install[Go {go-version}] or newer (check with the `go version` command)
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the source tarball (`v{full-version}.tar.gz`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the source tarball (`v{full-version}.tar.gz`).
. Download and uncompress the file.
+
[source,shell,subs="attributes"]
Expand Down Expand Up @@ -161,7 +224,7 @@ The Hazelcast CLC is supported on Windows 10 or newer versions. We provide pre-b
====
Installer::
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the Windows installer file (`hazelcast-clc-setup-v{full-version}.exe`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the Windows installer file (`hazelcast-clc-setup-v{full-version}.exe`).
. Download and the run the installer on your system to start the installation wizard.
. Follow the steps on the wizard; when you see the "Completing the Hazelcast CLC Setup Wizard" dialog, press kbd:[Finish] to complete the installation.
. `clc.exe` is automatically added to the `PATH` environment variable, so it can be started in the terminal without its full path.
Expand All @@ -174,12 +237,13 @@ clc.exe
ZIP::
+
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases/latest[latest release page], and locate the Windows ZIP file (`hazelcast-clc_v{full-version}_windows_amd64.zip`).
. Go to the https://github.com/hazelcast/hazelcast-commandline-client/releases[releases page], and locate the Windows ZIP file (`hazelcast-clc_v{full-version}_windows_amd64.zip`).
. Download and unzip the file.
. Optionally make `clc.exe` available without using its full path. You can do that by adding the full path of the extracted directory to the `PATH` environment variable.
====

endif::[]
== Verifying the Hazelcast CLC Installation

To check whether the Hazelcast CLC is installed properly, run the following command on a terminal.
Expand All @@ -189,7 +253,7 @@ To check whether the Hazelcast CLC is installed properly, run the following comm
clc version
----

You should see the Hazelcast CLC version information.
If installed, the Hazelcast CLC version information displays.

== Uninstalling the Hazelcast CLC

Expand Down

0 comments on commit ab852ba

Please sign in to comment.