@@ -10,54 +10,63 @@ Stackable provides pre-compiled binaries of stackablectl, which should work on m
1010and Linux distributions like Ubuntu and Arch. You can also build the binary from source. More information about the
1111manual building steps can be found in xref:#building-from-source[this] section.
1212
13- === Linux
14-
13+ [tabs]
14+ ====
15+ Linux::
16+ +
17+ --
1518Download the `stackablectl-x86_64-unknown-linux-gnu` binary file from the link:{latest-release}[latest release], then
1619rename the file to `stackablectl`. You can also use the following command:
1720
1821[source,console]
1922----
20- curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-x86_64-unknown-linux-gnu
23+ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-x86_64-unknown-linux-gnu
2124# or
22- curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-aarch64-unknown-linux-gnu
25+ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-aarch64-unknown-linux-gnu
2326----
2427
2528Mark the binary as executable:
2629
2730[source,console]
2831----
29- chmod +x stackablectl
32+ $ chmod +x stackablectl
3033----
3134
3235Then, make sure it is present in your `$PATH`, like `/usr/local/bin`.
36+ --
3337
34- === macOS
35-
38+ macOS::
39+ +
40+ --
3641Download the `stackablectl-x86_64-apple-darwin` binary file for Intel-based devices or the
3742`stackablectl-aarch64-apple-darwin` binary file for ARM-based devices from the link:{latest-release}[latest release],
3843then rename the file to `stackablectl`. You can also use the following command:
3944
4045[source,console]
4146----
42- curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-x86_64-apple-darwin
47+ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-x86_64-apple-darwin
4348# or
44- curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-aarch64-apple-darwin
49+ $ curl -L -o stackablectl https://github.com/stackabletech/stackable-cockpit/releases/download/stackablectl-24.3.2/stackablectl-aarch64-apple-darwin
4550----
4651
4752Mark the binary as executable:
4853
4954[source,console]
5055----
51- chmod +x stackablectl
56+ $ chmod +x stackablectl
5257----
5358
5459If macOS denies the execution of `stackablectl` go to Settings -> Security & Privacy -> General. Here you will see a pop
5560up asking if you want to allow access for `stackablectl`. You must allow access.
61+ --
5662
57- === Windows
58-
63+ Windows::
64+ +
65+ --
5966Currently, there are no pre-built binaries available for Windows. Please refer to xref:#building-from-source[this]
6067section to learn how to build the binary from source.
68+ --
69+ ====
6170
6271[#building-from-source]
6372== Building from Source
@@ -73,15 +82,15 @@ binary using the following command:
7382
7483[source,console]
7584----
76- cargo build -p stackablectl --release
85+ $ cargo build -p stackablectl --release
7786----
7887
7988After a successful build, the binary will be placed in `target/release/stackablectl`. Copy it to your systems path to
8089access it from anywhere if you like:
8190
8291[source,console]
8392----
84- cp target/release/stackablectl /usr/local/bin
93+ $ cp target/release/stackablectl /usr/local/bin
8594----
8695
8796[#shell-comps]
@@ -91,36 +100,43 @@ We provide completions for `stackablectl` for major shells out there. Currently,
91100repository provides pre-generated completion files. These can be downloaded and copied to the appropriate location on
92101your system.
93102
94- === ZSH
95-
103+ [tabs]
104+ ====
105+ ZSH::
106+ +
107+ --
96108Download the completions file and place it in `/usr/local/share/zsh/site-functions/` to load it automatically.
97109
98110[source,console]
99111----
100- wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/_stackablectl
101- mv _stackablectl /usr/local/share/zsh/site-functions/
112+ $ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/_stackablectl
113+ $ mv _stackablectl /usr/local/share/zsh/site-functions/
102114----
115+ --
103116
104- === Fish
105-
117+ Fish::
118+ +
119+ --
106120Download the completions file and place it in any of the supported location listed {fish-comp-loations}[here].
107121
108122[source,console]
109123----
110- wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.fish
124+ $ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.fish
111125----
126+ --
112127
113- === Bash
114-
128+ Bash::
129+ +
130+ --
115131Download the completions file and place it in `/etc/bash_completion.d/` to load it automatically.
116132
117133[source,console]
118134----
119- wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.bash
120- mv stackablectl.bash /etc/bash_completion.d/
135+ $ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.bash
136+ $ mv stackablectl.bash /etc/bash_completion.d/
121137----
138+ --
139+ ====
122140
123- '''
124-
125- You can generate the completions on your own by using the `stackablectl completions` command. See
126- xref:commands/completions.adoc[here] for more information.
141+ You can generate the completions on your own by using the `stackablectl completions` command.
142+ See xref:commands/completions.adoc[here] for more information.
0 commit comments