@@ -10,54 +10,63 @@ Stackable provides pre-compiled binaries of stackablectl, which should work on m
10
10
and Linux distributions like Ubuntu and Arch. You can also build the binary from source. More information about the
11
11
manual building steps can be found in xref:#building-from-source[this] section.
12
12
13
- === Linux
14
-
13
+ [tabs]
14
+ ====
15
+ Linux::
16
+ +
17
+ --
15
18
Download the `stackablectl-x86_64-unknown-linux-gnu` binary file from the link:{latest-release}[latest release], then
16
19
rename the file to `stackablectl`. You can also use the following command:
17
20
18
21
[source,console]
19
22
----
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
21
24
# 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
23
26
----
24
27
25
28
Mark the binary as executable:
26
29
27
30
[source,console]
28
31
----
29
- chmod +x stackablectl
32
+ $ chmod +x stackablectl
30
33
----
31
34
32
35
Then, make sure it is present in your `$PATH`, like `/usr/local/bin`.
36
+ --
33
37
34
- === macOS
35
-
38
+ macOS::
39
+ +
40
+ --
36
41
Download the `stackablectl-x86_64-apple-darwin` binary file for Intel-based devices or the
37
42
`stackablectl-aarch64-apple-darwin` binary file for ARM-based devices from the link:{latest-release}[latest release],
38
43
then rename the file to `stackablectl`. You can also use the following command:
39
44
40
45
[source,console]
41
46
----
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
43
48
# 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
45
50
----
46
51
47
52
Mark the binary as executable:
48
53
49
54
[source,console]
50
55
----
51
- chmod +x stackablectl
56
+ $ chmod +x stackablectl
52
57
----
53
58
54
59
If macOS denies the execution of `stackablectl` go to Settings -> Security & Privacy -> General. Here you will see a pop
55
60
up asking if you want to allow access for `stackablectl`. You must allow access.
61
+ --
56
62
57
- === Windows
58
-
63
+ Windows::
64
+ +
65
+ --
59
66
Currently, there are no pre-built binaries available for Windows. Please refer to xref:#building-from-source[this]
60
67
section to learn how to build the binary from source.
68
+ --
69
+ ====
61
70
62
71
[#building-from-source]
63
72
== Building from Source
@@ -73,15 +82,15 @@ binary using the following command:
73
82
74
83
[source,console]
75
84
----
76
- cargo build -p stackablectl --release
85
+ $ cargo build -p stackablectl --release
77
86
----
78
87
79
88
After a successful build, the binary will be placed in `target/release/stackablectl`. Copy it to your systems path to
80
89
access it from anywhere if you like:
81
90
82
91
[source,console]
83
92
----
84
- cp target/release/stackablectl /usr/local/bin
93
+ $ cp target/release/stackablectl /usr/local/bin
85
94
----
86
95
87
96
[#shell-comps]
@@ -91,36 +100,43 @@ We provide completions for `stackablectl` for major shells out there. Currently,
91
100
repository provides pre-generated completion files. These can be downloaded and copied to the appropriate location on
92
101
your system.
93
102
94
- === ZSH
95
-
103
+ [tabs]
104
+ ====
105
+ ZSH::
106
+ +
107
+ --
96
108
Download the completions file and place it in `/usr/local/share/zsh/site-functions/` to load it automatically.
97
109
98
110
[source,console]
99
111
----
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/
102
114
----
115
+ --
103
116
104
- === Fish
105
-
117
+ Fish::
118
+ +
119
+ --
106
120
Download the completions file and place it in any of the supported location listed {fish-comp-loations}[here].
107
121
108
122
[source,console]
109
123
----
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
111
125
----
126
+ --
112
127
113
- === Bash
114
-
128
+ Bash::
129
+ +
130
+ --
115
131
Download the completions file and place it in `/etc/bash_completion.d/` to load it automatically.
116
132
117
133
[source,console]
118
134
----
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/
121
137
----
138
+ --
139
+ ====
122
140
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