Skip to content

Commit e38da81

Browse files
committed
docs: add Linux CLI terminal installation instructions and clean up outdated steps
1 parent 1f7d7ca commit e38da81

File tree

1 file changed

+14
-49
lines changed

1 file changed

+14
-49
lines changed

docs/Getting-Started/polykey-cli/installation.md

Lines changed: 14 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -42,64 +42,29 @@ libraries that Node.js requires.
4242

4343
### Manually
4444

45-
Builds for Linux is released on GitHub:
46-
https://github.com/MatrixAI/Polykey-CLI/releases.
47-
48-
Download the executable named `...-polykey-cli-V.V.V-linux-x64`, and rename it
49-
to `polykey`.
50-
51-
Make it executable:
52-
53-
```sh
54-
$ chmod u+x ./polykey
55-
```
56-
57-
### Add it to your `$PATH`.
58-
59-
#### For ZSH:
60-
61-
1. `cd` into directory where polykey exec is stored.
62-
2. Edit the zsh config to add polykey to your path. To streamline the process,
63-
run the following command, making sure to change the path to polykey if the
64-
polykey executable is not in the downloads folder.
65-
3. For most users, this would be `~/Downloads`
66-
67-
:::warning
68-
69-
Make sure your path to the polykey executable is correct.
45+
#### Using the Polykey CLI via the terminal
7046

71-
:::
72-
73-
```sh
74-
$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
75-
```
76-
77-
You only need to run this command once. After running this command, you can now
78-
invoke polykey by typing `polykey` into the terminal.
79-
80-
---
47+
If you prefer not to use a package manager or Docker, you can install Polykey directly via the terminal using a prebuilt binary.
8148

82-
#### For Bash:
49+
1. Download the executable from the [GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases) and rename it to `polykey`.
8350

84-
1. `cd` into directory where polykey exec is stored.
85-
2. Edit the zsh config to add polykey to your path. To streamline the process,
86-
run the following command, making sure to change the path to polykey if the
87-
polykey executable is not in the downloads folder.
88-
3. For most users, this would be `~/Downloads`
51+
2. Make it executable:
8952

90-
:::warning
53+
```sh
54+
chmod u+x ./polykey
9155

92-
Make sure your path to the polykey executable is correct.
56+
3. Move it into a directory in your $PATH, or add the current directory to your $PATH temporarily:
57+
* For ZSH:
9358

94-
:::
59+
echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
9560

96-
```sh
97-
$ echo 'export PATH=~/Downloads/polykey:$PATH' >> ~/.bashrc && source ~/.bashrc
98-
```
61+
* For Bash:
62+
echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source ~/.bashrc
9963

100-
You only need to run this command once. After running this command, you can now
101-
invoke polykey by typing `polykey` into the terminal.
64+
4. Confirm the installation:
65+
polykey --version
10266

67+
If it returns the version, you’re ready to use the CLI.
10368
---
10469

10570
### NixOS

0 commit comments

Comments
 (0)