Skip to content

Commit a13762a

Browse files
authored
docs: add guide for installing qleetctl (#32)
* docs: add guide for installing qleetctl Signed-off-by: Rich Lander <[email protected]> * docs: improve install instructions Signed-off-by: Rich Lander <[email protected]> --------- Signed-off-by: Rich Lander <[email protected]>
1 parent 864ca18 commit a13762a

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

docs/guides/install.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Install
2+
3+
Use the following instructions to install the `qleetctl` command line tool for
4+
using Qleet.
5+
6+
1. Visit the [releases page](https://github.com/qleet/resources/releases) on
7+
github and download:
8+
9+
1. `checksums.txt`
10+
11+
1. the latest pacakge for your computer's architecture
12+
13+
1. Verify the integrity of the downloaded package.
14+
```bash
15+
sha256sum -c --ignore-missing checksums.txt
16+
```
17+
1. Extract `qleetctl`. Example here is for v0.0.10. Adjust as necessary for
18+
the version you're installing.
19+
```bash
20+
tar xf qleetctl_v0.0.10_Darwin_arm64.tar.gz
21+
```
22+
1. Move `qleetctl` to your path.
23+
```bash
24+
sudo mv qleetctl_v0.0.10_Darwin_arm64/qleetctl /usr/local/bin/
25+
```
26+
1. Check the version installed.
27+
```bash
28+
qleetctl version
29+
```
30+
1. View help info.
31+
```bash
32+
qleetctl help
33+
```
34+
1. Clean up.
35+
```bash
36+
rm checksums.txt qleetctl_v0.0.10_Darwin_arm64.tar.gz
37+
rm -rf qleetctl_v0.0.10_Darwin_arm64
38+
```
39+

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ edit_uri: blob/main/docs/
77
nav:
88
- Qleet: 'index.md'
99
- Guides:
10-
- 'guides/account-setup.md'
10+
- 'guides/install.md'
1111

1212
theme:
1313
name: material

0 commit comments

Comments
 (0)