Skip to content

Commit 18de1a4

Browse files
authored
docs(stackablectl): simplify install steps (#315)
* docs(stackablectl): fix installation command so that copying doesn't run both * docs(stackablectl): simplify install commands
1 parent 4668d6e commit 18de1a4

File tree

1 file changed

+52
-11
lines changed

1 file changed

+52
-11
lines changed

docs/modules/stackablectl/pages/installation.adoc

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,49 +15,83 @@ manual building steps can be found in xref:#building-from-source[this] section.
1515
Linux::
1616
+
1717
--
18-
Download the `stackablectl-x86_64-unknown-linux-gnu` binary file from the link:{latest-release}[latest release], then
19-
rename the file to `stackablectl`. You can also use the following command:
18+
Download the appropriate binary file for your architecture, `stackablectl-x86_64-unknown-linux-gnu` for Intel-based devices or
19+
`stackablectl-aarch64-unknown-linux-gnu` for ARM-based devices from the link:{latest-release}[latest release],
20+
then rename the file to `stackablectl`. You can also use the following command:
21+
22+
*x86_64* (amd64):
2023
2124
[source,console]
2225
----
2326
$ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-x86_64-unknown-linux-gnu
24-
# or
27+
----
28+
29+
**aarch64** (arm64):
30+
31+
[source,console]
32+
----
2533
$ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-unknown-linux-gnu
2634
----
2735
28-
Mark the binary as executable:
36+
Install the binary into a directory in the `$PATH`, and make it executable:
37+
38+
NOTE: If you have a directory in your `$HOME` for user binaries, you can remove `sudo`, and change the directory to that.
2939
3040
[source,console]
3141
----
32-
$ chmod +x stackablectl
42+
$ sudo install -m 755 -t /usr/local/bin stackablectl
3343
----
3444
35-
Then, make sure it is present in your `$PATH`, like `/usr/local/bin`.
45+
Test that it works:
46+
47+
[source,console]
48+
----
49+
$ stackablectl --version
50+
----
3651
--
3752
3853
macOS::
3954
+
4055
--
41-
Download the `stackablectl-x86_64-apple-darwin` binary file for Intel-based devices or the
42-
`stackablectl-aarch64-apple-darwin` binary file for ARM-based devices from the link:{latest-release}[latest release],
56+
Download the appropriate binary file for your architecture, `stackablectl-x86_64-apple-darwin` for Intel-based devices or
57+
`stackablectl-aarch64-apple-darwin` for ARM-based devices from the link:{latest-release}[latest release],
4358
then rename the file to `stackablectl`. You can also use the following command:
4459
60+
*x86_64* (amd64):
61+
4562
[source,console]
4663
----
4764
$ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-x86_64-apple-darwin
48-
# or
65+
----
66+
67+
**aarch64** (arm64):
68+
69+
[source,console]
70+
----
4971
$ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.7.0/stackablectl-aarch64-apple-darwin
5072
----
5173
52-
Mark the binary as executable:
74+
Install the binary into a directory in the `$PATH`, and make it executable:
75+
76+
NOTE: If you have a directory in your `$HOME` for user binaries, you can remove `sudo`, and change the directory to that.
77+
78+
[source,console]
79+
----
80+
$ sudo install -m 755 -t /usr/local/bin stackablectl
81+
----
82+
83+
Test that it works:
5384
5485
[source,console]
5586
----
56-
$ chmod +x stackablectl
87+
$ stackablectl --version
5788
----
5889
90+
[TIP]
91+
====
5992
If macOS denies the execution of `stackablectl` go to Settings -> Security & Privacy -> General. Here you will see a pop
6093
up asking if you want to allow access for `stackablectl`. You must allow access.
94+
====
6195
--
6296
6397
Windows::
@@ -93,6 +127,13 @@ access it from anywhere if you like:
93127
$ cp target/release/stackablectl /usr/local/bin
94128
----
95129

130+
Test that it works:
131+
132+
[source,console]
133+
----
134+
$ stackablectl --version
135+
----
136+
96137
[#shell-comps]
97138
== Shell Completions
98139

0 commit comments

Comments
 (0)