Skip to content

Commit a15f6ea

Browse files
authored
docs: Add new completions, simplify install instructions (#345)
1 parent 63728b5 commit a15f6ea

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

docs/modules/stackablectl/pages/installation.adoc

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33

44
:latest-release: https://github.com/stackabletech/stackable-cockpit/releases/tag/stackablectl-24.11.1
55
:fish-comp-loations: https://fishshell.com/docs/current/completions.html#where-to-put-completions
6+
:nushell-comp-locations: https://www.nushell.sh/book/custom_commands.html#persisting
67

78
== Using Pre-Compiled Binaries
89

9-
Stackable provides pre-compiled binaries of stackablectl, which should work on most environments such as Windows, macOS,
10-
and Linux distributions like Ubuntu and Arch. You can also build the binary from source. More information about the
11-
manual building steps can be found in xref:#building-from-source[this] section.
10+
Stackable provides pre-compiled binaries of stackablectl, which should work on most environments such as Windows, macOS, and Linux distributions like Ubuntu and Arch.
11+
You can also build the binary from source.
12+
More information about the manual building steps can be found in xref:#building-from-source[this] section.
1213

1314
[tabs]
1415
====
1516
Linux::
1617
+
1718
--
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:
19+
Download the appropriate binary file for your architecture from the link:{latest-release}[latest release], then rename the file to `stackablectl`.
20+
You can also use the following command:
2121
2222
*x86_64* (amd64):
2323
@@ -53,9 +53,8 @@ $ stackablectl --version
5353
macOS::
5454
+
5555
--
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],
58-
then rename the file to `stackablectl`. You can also use the following command:
56+
Download the appropriate binary file for your architecture from the link:{latest-release}[latest release], then rename the file to `stackablectl`.
57+
You can also use the following command:
5958
6059
*x86_64* (amd64):
6160
@@ -137,9 +136,9 @@ $ stackablectl --version
137136
[#shell-comps]
138137
== Shell Completions
139138

140-
We provide completions for `stackablectl` for major shells out there. Currently, ZSH, Fish and Bash are supported. The
141-
repository provides pre-generated completion files. These can be downloaded and copied to the appropriate location on
142-
your system.
139+
We provide completions for `stackablectl` for major shells out there. Currently, ZSH, Fish, Bash, Nushell, and Elvish are supported.
140+
The repository provides pre-generated completion files.
141+
These can be downloaded and copied to the appropriate location on your system.
143142

144143
[tabs]
145144
====
@@ -150,7 +149,7 @@ Download the completions file and place it in `/usr/local/share/zsh/site-functio
150149
151150
[source,console]
152151
----
153-
$ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/_stackablectl
152+
$ curl -LO https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/_stackablectl
154153
$ mv _stackablectl /usr/local/share/zsh/site-functions/
155154
----
156155
--
@@ -162,7 +161,7 @@ Download the completions file and place it in any of the supported location list
162161
163162
[source,console]
164163
----
165-
$ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.fish
164+
$ curl -LO https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.fish
166165
----
167166
--
168167
@@ -173,10 +172,30 @@ Download the completions file and place it in `/etc/bash_completion.d/` to load
173172
174173
[source,console]
175174
----
176-
$ wget https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.bash
175+
$ curl -LO https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.bash
177176
$ mv stackablectl.bash /etc/bash_completion.d/
178177
----
179178
--
179+
180+
Nushell::
181+
+
182+
--
183+
Download the completions file at a location where it is loaded for all Nushell sessions, see {nushell-comp-locations}[here].
184+
185+
[source,console]
186+
----
187+
$ curl -LO https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.nu
188+
----
189+
--
190+
191+
Elvish::
192+
+
193+
--
194+
[source,console]
195+
----
196+
$ curl -LO https://raw.githubusercontent.com/stackabletech/stackable-cockpit/main/extra/completions/stackablectl.elv
197+
----
198+
--
180199
====
181200

182201
You can generate the completions on your own by using the `stackablectl completions` command.

0 commit comments

Comments
 (0)