Skip to content

Commit 685e87f

Browse files
CryptoTotalWartegefaulkes
authored andcommitted
docs: tentative changes to improve legibility
1 parent 4c0efd8 commit 685e87f

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

docs/tutorials/polykey-cli/installation.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ nix-env -f ./release.nix --install --attr application --argstr npmDepsHash "$(pr
9999

100100
We will be working on other distribution methods.
101101

102+
---
103+
102104
## MacOS
103105

104106
:::info
@@ -131,13 +133,13 @@ However, building Polykey yourself on MacOS resolves in a working binary. Follow
131133
chmod +x polykey
132134
```
133135

136+
---
137+
134138
### MacOS Security Bypass
135139

136140
MacOS requires additional steps for the binary to be allowed to execute,
137141
this is due to the fact that as of 20-12-23, the binaries we release are unsigned,
138-
and MacOS permits running of unsigned binaries, however, to progress past this, there are 2 common methods we will provide here:
139-
140-
#### Method #1 - Manual Intervention through MacOS Settings
142+
and MacOS permits running of unsigned binaries, however, to progress past this, follow these steps:
141143

142144
First type the following command to try running the Polykey CLI but will instead trigger a pop-up.
143145

@@ -176,32 +178,48 @@ When prompted in the terminal, type your administrator password and hit enter.
176178
#### Click on Open and now Polykey-CLI should be running in your terminal window.
177179

178180
:::tip
179-
You can now verify the version of polykey that was installed with:
181+
You can also verify the version of polykey that was installed with:
180182

181183
```sh
182184
./polykey --version
183185
```
184186

185187
:::
186188

189+
---
190+
187191
### Add it to your `$PATH`.
188192

189-
#### For ZSH:
193+
To add the Polykey CLI executable to your $PATH on macOS, which allows you to run the polykey command from any directory in the terminal, you need to update the shell configuration file.
194+
195+
:::tip
196+
197+
To check the shell you're currently using (ZSH vs Bash), in terminal type `echo $SHELL`
198+
:::
199+
200+
#### For ZSH (default shell on recent versions of macOS):
190201

191202
1. `cd` into the directory where the "polykey" executable is stored.
192-
2. Edit the Zsh config to add "polykey" to your path. To streamline the process, run the following command, making sure to change the path to "polykey" if the executable is not in the downloads folder. For most users, this would be `~/downloads` on Debian-based systems.
203+
204+
2. Edit the Zsh config to add "polykey" to your $path. To streamline the process, run the following command, making sure to change the path to "polykey" if the executable is not in the downloads folder. For most users, this would be `~/downloads` on Debian-based systems.
193205

194206
:::tip
195207

196-
Make sure your path to the "polykey" executable is correct.
208+
Make sure your path to the "polykey" executable is correct. Replace `downloads` with the path to the working directory. Use the `pwd` command to print the working directory.
197209

198210
:::
199211

200212
```sh
201-
echo 'export PATH=~/downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
213+
echo 'export PATH=~/downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
202214
```
203215

204-
You can now run it with `polykey`.
216+
:::tip
217+
218+
You can check if the PATH environment variable for Polykey has been updated correctly with `echo $PATH`
219+
220+
:::
221+
222+
You can now run `polykey` from anywhere in your terminal.
205223

206224
---
207225

@@ -212,15 +230,15 @@ You can now run it with `polykey`.
212230

213231
:::tip
214232

215-
Make sure your path to the "polykey" executable is correct.
233+
Make sure your path to the "polykey" executable is correct. Replace `downloads` with the path to the working directory
216234

217235
:::
218236

219237
```sh
220238
echo 'export PATH=~/downloads:$PATH' >> ~/.bashrc && source ~/.bashrc
221239
```
222240

223-
You can now run it with `polykey`.
241+
You can now run `polykey` from anywhere in your terminal.
224242

225243
---
226244

0 commit comments

Comments
 (0)