Skip to content

Commit 3ebccf1

Browse files
CryptoTotalWartegefaulkes
authored andcommitted
docs: placeholder for tabs & overall content structuring
1 parent 685e87f commit 3ebccf1

File tree

1 file changed

+43
-17
lines changed

1 file changed

+43
-17
lines changed

docs/tutorials/polykey-cli/installation.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
<Tabs>
5+
<TabItem value="apple" label="Apple" default>
6+
This is an apple 🍎
7+
</TabItem>
8+
<TabItem value="orange" label="Orange">
9+
This is an orange 🍊
10+
</TabItem>
11+
<TabItem value="banana" label="Banana">
12+
This is a banana 🍌
13+
</TabItem>
14+
</Tabs>
15+
116
# Installation
217

318
Installing the CLI can be done in different ways depending on your operating environment.
@@ -122,8 +137,8 @@ However, building Polykey yourself on MacOS resolves in a working binary. Follow
122137

123138
:::tip
124139

125-
- Replace `V.V.V.` with the actual version number of the file you downloaded.
126140
- Navigate into the directory where the file is saved to execute commands.
141+
- Replace `V.V.V.` with the actual version number of the file you downloaded.
127142

128143
:::
129144

@@ -139,7 +154,19 @@ chmod +x polykey
139154

140155
MacOS requires additional steps for the binary to be allowed to execute,
141156
this is due to the fact that as of 20-12-23, the binaries we release are unsigned,
142-
and MacOS permits running of unsigned binaries, however, to progress past this, follow these steps:
157+
and MacOS permits running of unsigned binaries, however, to progress past this, there are a couple options:
158+
159+
#### Method #1 - quickest method
160+
161+
The xattr command will remove the quarantine attribute from the polykey executable, allowing you to run it without triggering macOS security warnings. Remember to ensure that the file path matches the location of your polykey file.
162+
163+
```sh
164+
sudo xattr -r -d com.apple.quarantine ~/Downloads/polykey
165+
```
166+
167+
If you have completed this sucesfully, you may ignore Method #2 and move to the next section on how to add polykey to your `$PATH`.
168+
169+
#### Method #2 - Using the Apple Systems Settings GUI
143170

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

@@ -188,38 +215,37 @@ You can also verify the version of polykey that was installed with:
188215

189216
---
190217

191-
### Add it to your `$PATH`.
218+
### Add Polykey to your `$PATH`.
192219

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.
220+
To enable running the Polykey CLI from any directory in the terminal on macOS, you'll need to update your shell configuration file.
194221

195-
:::tip
222+
#### For ZSH (default shell on recent macOS versions):
196223

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):
201-
202-
1. `cd` into the directory where the "polykey" executable is stored.
224+
1. Navigate (cd) into the directory where the "polykey" executable is stored.
203225

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.
226+
2. Edit the Zsh configuration file to add "polykey" to your $PATH. Use the following command, ensuring to replace ~/Downloads with the correct path to the "polykey" executable if it's not in the downloads folder. For most users, this path would be ~/Downloads on Debian-based systems.
205227

206228
:::tip
207229

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.
230+
Make sure your path to the "polykey" executable is correct.
209231

210232
:::
211233

212234
```sh
213-
echo 'export PATH=~/downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
235+
echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
214236
```
215237

216238
:::tip
217239

218-
You can check if the PATH environment variable for Polykey has been updated correctly with `echo $PATH`
240+
You can check if the PATH environment variable for Polykey has been updated correctly by running:
219241

220-
:::
242+
```sh
243+
polykey --version
244+
```
221245

222-
You can now run `polykey` from anywhere in your terminal.
246+
If this command returns the current version, then you have successfully added Polykey to your PATH, and you can now run polykey from anywhere in your terminal.
247+
248+
:::
223249

224250
---
225251

0 commit comments

Comments
 (0)