You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/polykey-cli/installation.md
+19-22Lines changed: 19 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,20 @@ Installing the CLI can be done in different ways depending on your operating env
4
4
5
5
:::warning
6
6
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.
8
8
9
9
:::
10
10
11
11
## Linux
12
12
13
13
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.
14
14
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`
21
21
22
22
### Manually
23
23
@@ -37,7 +37,7 @@ chmod u+x ./polykey
37
37
38
38
1.`cd` into directory where polykey exec is stored.
39
39
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.
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.
107
108
108
109
:::
109
110
110
-
111
111
Builds for MacOS are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
112
112
113
113
Download the executable named `...-polykey-cli-V.V.V-darwin-x64`, and rename it to `polykey`.
114
114
115
-
116
115
:::tip
117
116
118
117
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,
144
143
```shell
145
144
sudo ./polykey
146
145
```
146
+
147
147
5. Following this, you will get another similar prompt
148
148
149
149

@@ -198,27 +198,25 @@ Polykey doesn't work on Windows at all as of **20-12-23**, regardless of binarie
198
198
199
199
:::
200
200
201
-
202
201
Builds for Windows are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
203
202
204
203
Download the executable named `...-polykey-cli-V.V.V-win32-x64`, and rename it to `polykey.exe`.
205
204
206
-
207
-
208
205
#### Add to PATH
209
206
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`.
211
208
212
209
```shell
213
210
setx PATH "%PATH%;%CD%" /M
214
211
```
212
+
215
213
:::tip
216
214
217
215
Make sure you're in the correct directory where "polykey.exe" is placed.
218
216
219
217
:::
220
218
221
-
2. Now you can run polykey system-wide by using ``polykey``.
219
+
2. Now you can run polykey system-wide by using `polykey`.
222
220
223
221
## Docker
224
222
@@ -246,13 +244,14 @@ Nix for mac can be installed by running
246
244
```sh
247
245
sh <(curl -L https://nixos.org/nix/install)
248
246
```
247
+
249
248
:::
250
249
251
250
1. Download the latest build of Polykey-CLI for docker from https://polykey.com/download.
252
251
253
252
2. Download Docker for MacOS depending on your instruction-set (arm vs x86) from https://docs.docker.com/desktop/install/mac-install/
254
253
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`
0 commit comments