Skip to content

Commit 552b1fc

Browse files
CryptoTotalWartegefaulkes
authored andcommitted
docs: note Polykey-CLI testing on Linux and macOS
Added macOS to the list of tested platforms in the Polykey-CLI section to inform users of the extended compatibility.
1 parent 53661ef commit 552b1fc

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

docs/tutorials/polykey-cli/installation.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ Installing the CLI can be done in different ways depending on your operating env
44

55
:::warning
66

7-
Polykey-CLI has only been tested on Linux. We are working on supporting other platforms. There's minor teething problems when it comes supporting other platforms. Help us by reporting issues.
7+
Polykey-CLI has only been tested on Linux and macOS. We are working on supporting other platforms. There's minor teething problems when it comes supporting other platforms. Help us by reporting issues.
88

99
:::
1010

1111
## Linux
1212

1313
Polykey-CLI code is compiled, bundled and wrapped into a single file executable. You just have to download the executable, give it executable permissions and run it. The executable is not statically linked. It requires a subset of the system libraries that Node.js requires.
1414

15-
* `libdl.so.2`
16-
* `libstdc++.so.6`
17-
* `libm.so.6`
18-
* `libgcc_s.so.1`
19-
* `libpthread.so.0`
20-
* `libc.so.6`
15+
- `libdl.so.2`
16+
- `libstdc++.so.6`
17+
- `libm.so.6`
18+
- `libgcc_s.so.1`
19+
- `libpthread.so.0`
20+
- `libc.so.6`
2121

2222
### Manually
2323

@@ -37,7 +37,7 @@ chmod u+x ./polykey
3737

3838
1. `cd` into directory where polykey exec is stored.
3939
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 polykey executable is not in the downloads folder.
40-
3. For most users, this would be ``~/downloads`` on Debian based systems.
40+
3. For most users, this would be `~/downloads` on Debian based systems.
4141

4242
:::warning
4343

@@ -52,6 +52,7 @@ echo 'export PATH=~/downloads/polykey:$PATH' >> ~/.zshrc && source ~/.zshrc
5252
You can now run it with `polykey`.
5353

5454
---
55+
5556
#### For Bash:
5657

5758
1. If you're using Bash, run the following command to add polykey to your path. Ensure to change the path if the executable is not in the downloads folder. For most users, this would be `~/downloads` on Debian-based systems.
@@ -107,12 +108,10 @@ However, building polykey yourself on MacOS resolves in a working binary.
107108

108109
:::
109110

110-
111111
Builds for MacOS are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
112112

113113
Download the executable named `...-polykey-cli-V.V.V-darwin-x64`, and rename it to `polykey`.
114114

115-
116115
:::tip
117116

118117
Make sure to cd into the right directory first.
@@ -144,6 +143,7 @@ and MacOS permits running of unsigned binaries, however, to progress past this,
144143
```shell
145144
sudo ./polykey
146145
```
146+
147147
5. Following this, you will get another similar prompt
148148

149149
![install3](../../../images/mac-install3.png)
@@ -198,27 +198,25 @@ Polykey doesn't work on Windows at all as of **20-12-23**, regardless of binarie
198198

199199
:::
200200

201-
202201
Builds for Windows are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
203202

204203
Download the executable named `...-polykey-cli-V.V.V-win32-x64`, and rename it to `polykey.exe`.
205204

206-
207-
208205
#### Add to PATH
209206

210-
1. Run the following when you are in the same directory as ``polykey.exe``.
207+
1. Run the following when you are in the same directory as `polykey.exe`.
211208

212209
```shell
213210
setx PATH "%PATH%;%CD%" /M
214211
```
212+
215213
:::tip
216214

217215
Make sure you're in the correct directory where "polykey.exe" is placed.
218216

219217
:::
220218

221-
2. Now you can run polykey system-wide by using ``polykey``.
219+
2. Now you can run polykey system-wide by using `polykey`.
222220

223221
## Docker
224222

@@ -246,13 +244,14 @@ Nix for mac can be installed by running
246244
```sh
247245
sh <(curl -L https://nixos.org/nix/install)
248246
```
247+
249248
:::
250249

251250
1. Download the latest build of Polykey-CLI for docker from https://polykey.com/download.
252251

253252
2. Download Docker for MacOS depending on your instruction-set (arm vs x86) from https://docs.docker.com/desktop/install/mac-install/
254253

255-
3. Rename the Polykey dist from ``x-docker-image-polykey-cli-x.x.x-alpha.x.tar.gz`` to ``docker-polykey.tar.gz``
254+
3. Rename the Polykey dist from `x-docker-image-polykey-cli-x.x.x-alpha.x.tar.gz` to `docker-polykey.tar.gz`
256255

257256
4. Load the image in docker using the following:
258257

@@ -264,11 +263,11 @@ docker load --input docker-polykey.tar.gz
264263

265264
![img.png](../../../images/docker-mac-img1.png)
266265

267-
6. Run ```mkdir /tmp/polykey``` to create a directory for the polykey nodepath
266+
6. Run `mkdir /tmp/polykey` to create a directory for the polykey nodepath
268267

269-
7. Set the volume host path to ```/tmp/polykey``` and the container path to ```/tmp/polykey/```
268+
7. Set the volume host path to `/tmp/polykey` and the container path to `/tmp/polykey/`
270269

271-
8. Run ``docker images`` to grab the Image ID of your installed image.
270+
8. Run `docker images` to grab the Image ID of your installed image.
272271

273272
```shell
274273
> docker images
@@ -282,8 +281,7 @@ polykey-cli-0.1.2-alpha.2 gygbx1qgpnhbvbcbaby3sfm19bamg7sx 0e1addd9855a 12
282281
docker run -it 0e1addd9855a agent start --background -np /tmp/polykey
283282
```
284283

285-
Making sure to replace ``0e1addd9855a`` with your corresponding image ID.
286-
284+
Making sure to replace `0e1addd9855a` with your corresponding image ID.
287285

288286
```shell
289287
 docker run -it 0e1addd9855a agent start --background -np /tmp/polykey
@@ -300,7 +298,6 @@ recoveryCode net elephant gentle eight pulp oyster panther sing own autumn silly
300298
301299
```
302300
303-
304301
## Node Package Manager
305302
306303
The CLI is published as [`npm` package](https://www.npmjs.com/package/polykey-cli).

0 commit comments

Comments
 (0)