Skip to content

Commit 5315d42

Browse files
committed
docs: clarify Linux PATH setup for manual Polykey installation
1 parent 910eca0 commit 5315d42

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,16 @@ directly via the terminal using a prebuilt binary.
5757
chmod u+x ./polykey
5858
```
5959

60-
3. Move it into a directory in your
61-
$PATH, or add the current directory to your
62-
$PATH temporarily:
60+
3. Add the executable to your PATH
61+
62+
To run `polykey` from anywhere, you need to add the directory containing it to your `PATH`. You can either:
63+
64+
- Move `polykey` into an existing directory already in your `PATH` (e.g., `/usr/local/bin`), **or**
65+
- Add the current directory to your `PATH`, either temporarily or permanently:
66+
67+
**Temporary (until terminal closes):**
68+
```sh
69+
export PATH="$PWD:$PATH"
6370

6471
4. Confirm the installation:
6572

@@ -83,16 +90,18 @@ a terminal to restart it.
8390
- For ZSH:
8491

8592
```shell
86-
export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
93+
export PATH="$HOME/Downloads:$PATH"' >> ~/.zshrc && source ~/.zshrc
8794
```
8895
8996
- For Bash:
9097
98+
– For Bash:
99+
91100
```shell
92-
export PATH=~/Downloads:$PATH >> ~/.bashrc && source ~/.bashrc && source
101+
echo 'export PATH="$HOME/Downloads:$PATH"' >> ~/.bashrc && source ~/.bashrc
93102
```
94103
95-
4. Confirm the installation:
104+
4. Confirm the installation with:
96105
```sh
97106
polykey --version
98107
```

0 commit comments

Comments
 (0)