@@ -68,14 +68,15 @@ your `PATH`. You can either:
6868
6969** Temporary (until terminal closes):**
7070
71- ```` sh
71+ ``` shell
7272export PATH=" $PWD :$PATH "
73+ ```
7374
74754 . Confirm the installation:
7576
76- ` ` ` sh
77+ ``` shell
7778 polykey --version
78- ` ` ` `
79+ ```
7980
80815 . If it returns the version, you’re ready to use the CLI.
8182
@@ -102,10 +103,42 @@ echo 'export PATH="$HOME/Downloads:$PATH"' >> ~/.zshrc && source ~/.zshrc
102103echo ' export PATH="$HOME/Downloads:$PATH"' >> ~ /.bashrc && source ~ /.bashrc
103104```
104105
106+ :::tip Setting PATH across operating systems
107+
108+ Where you place the ` polykey ` binary — and how you add it to your ` PATH ` —
109+ depends on your OS:
110+
111+ - ** Linux** : Preferred location is ` ~/.local/bin ` (you may need to create it
112+ using ` mkdir -p ~/.local/bin ` ). Make sure this directory is included in your
113+ ` $PATH ` — often via ` ~/.bashrc ` , ` ~/.bash_profile ` , or ` ~/.profile ` .
114+
115+ - ** macOS** : Same as Linux — use ` ~/.local/bin ` or ` ~/bin ` . Update your ` $PATH `
116+ in ` ~/.zshrc ` (ZSH is default on macOS since Catalina) or ` ~/.bash_profile ` if
117+ using Bash.
118+
119+ - ** Windows** : Place ` polykey.exe ` into:
120+
121+ ``` shell
122+ %USERPROFILE%\A ppData\L ocal\M icrosoft\W indowsApps
123+ ```
124+
125+ This location is typically already included in the system PATH.
126+
127+ To verify it’s working, run:
128+
129+ ``` shell
130+ which polykey
131+ polykey --version
132+
133+ ```
134+
135+ :::
136+
1051374 . Confirm the installation with:
106- ` ` ` sh
138+
139+ ``` shell
107140 polykey --version
108- ` ` `
141+ ```
109142
110143If it returns the version, you’re ready to use the CLI.
111144
@@ -282,16 +315,21 @@ not appear in the next step. :::
282315sudo ./polykey
283316```
284317
285- :::tip Tip When prompted in the terminal, type your administrator password and
286- hit enter. :::
318+ :::tip Tip
319+
320+ When prompted in the terminal, type your administrator password and hit enter.
321+
322+ :::
287323
2883245 . Following this, you will get another similar prompt
289325
290326![ install3] ( /images/mac-install3.png )
291327
292328#### Click on Open and now Polykey-CLI should be running in your terminal window.
293329
294- :::tip Tip You can also verify the version of polykey that was installed with:
330+ :::tip Tip
331+
332+ You can also verify the version of polykey that was installed with:
295333
296334``` sh
297335./polykey --version
@@ -421,7 +459,7 @@ terminal.
421459 </TabItem >
422460 <TabItem value =" windows " label =" Windows " >
423461
424- :::warning
462+ :::warning Warning
425463
426464Polykey for windows should be working but we have yet to create documentation on
427465the installation process for this. Check back soon!
0 commit comments