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
docs: Update installation instructions and add support links
- Add links to the Polykey CLI GitHub Issues page for bug reporting.
- Add links to the Matrix AI Discord server for further assistance.
- Implement tabs throughout the entire page for better organization.
- Note potential issue with sub-navigation pane not working with tabs.
Copy file name to clipboardExpand all lines: docs/tutorials/polykey-cli/installation.md
+52-53Lines changed: 52 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,19 @@
1
1
import Tabs from '@theme/Tabs';
2
2
import TabItem from '@theme/TabItem';
3
3
4
-
<Tabs>
5
-
<TabItemvalue="apple"label="Apple"default>
6
-
This is an apple 🍎
7
-
</TabItem>
8
-
<TabItemvalue="orange"label="Orange">
9
-
This is an orange 🍊
10
-
</TabItem>
11
-
<TabItemvalue="banana"label="Banana">
12
-
This is a banana 🍌
13
-
</TabItem>
14
-
</Tabs>
15
-
16
4
# Installation
17
5
18
6
Installing the CLI can be done in different ways depending on your operating environment.
19
7
20
-
:::warning
8
+
:::info
21
9
22
-
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. `where & How?`
10
+
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 any issues with the CLI tool in our Github Repo [here](https://github.com/MatrixAI/Polykey-CLI/issues/new/choose) or by dropping a message to the developers in our discord server [here](https://discord.gg/dC32r35TeE).
23
11
24
12
:::
25
13
14
+
<Tabs>
15
+
<TabItemvalue="linux"label="Linux"default>
16
+
26
17
## Linux
27
18
28
19
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.
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.
You can check if the PATH environment variable for Polykey has been updated correctly by running:
241
-
242
-
```sh
243
-
polykey --version
244
-
```
245
-
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
-
:::
249
-
250
-
---
245
+
</TabItem>
246
+
<TabItemvalue="bash"label="Bash">
251
247
252
248
#### For Bash:
253
249
@@ -264,41 +260,34 @@ Make sure your path to the "polykey" executable is correct. Replace `downloads`
You can now run `polykey` from anywhere in your terminal.
263
+
</TabItem>
264
+
</Tabs>
268
265
269
-
---
266
+
:::tip
270
267
271
-
## Windows
268
+
You can check if the PATH environment variable for Polykey has been updated correctly by running:
272
269
273
-
:::danger
270
+
```sh
271
+
polykey --version
272
+
```
274
273
275
-
Polykey doesn't work on Windows at all as of **20-12-23**, regardless of binaries or building it yourself.
274
+
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.
276
275
277
276
:::
278
277
279
-
Builds for Windows are released on GitHub: https://github.com/MatrixAI/Polykey-CLI/releases.
280
-
281
-
Download the executable named `...-polykey-cli-V.V.V-win32-x64`, and rename it to `polykey.exe`.
282
-
283
-
#### Sudo Method with your terminal
284
-
285
-
#### Add to PATH
286
-
287
-
1. Run the following when you are in the same directory as `polykey.exe`.
288
-
289
-
```shell
290
-
setx PATH "%PATH%;%CD%" /M
291
-
```
278
+
</TabItem>
279
+
<TabItemvalue="windows"label="Windows">
292
280
293
-
:::tip
281
+
:::warning
294
282
295
-
Make sure you're in the correct directory where "polykey.exe" is placed.
283
+
Polykey for windows should be working but we have yet to create documentation on the installation process for this.
296
284
297
285
:::
298
286
299
-
2. Now you can run polykey system-wide by using `polykey`.
300
-
301
-
## Docker
287
+
</TabItem>
288
+
<TabItemvalue="docker"label="Docker">
289
+
290
+
## Docker
302
291
303
292
The Docker image can be used so that Polykey can be deployed into the cloud. It is also possible to use the CLI via the docker container, but it isn't as convenient. The intention is to run the Polykey agent in the cloud.
304
293
@@ -378,6 +367,9 @@ recoveryCode net elephant gentle eight pulp oyster panther sing own autumn silly
378
367
379
368
```
380
369
370
+
</TabItem>
371
+
<TabItem value="npm" label="npm">
372
+
381
373
## Node Package Manager
382
374
383
375
The CLI is published as [`npm` package](https://www.npmjs.com/package/polykey-cli).
@@ -392,6 +384,9 @@ This will install the Polykey-CLI into `$(npm config get prefix)`.
392
384
393
385
If the `npm` bin path is added to the `$PATH` environment variable, then you will be able to execute `pk` or `polykey`.
394
386
387
+
</TabItem>
388
+
<TabItem value="source" label="Source">
389
+
395
390
## Source
396
391
397
392
The official source repository is on GitHub. There is an additional mirror on GitLab.
@@ -407,3 +402,7 @@ Use `npm install` to setup the project.
407
402
If you have `nix-shell` available, enter into `nix-shell` and it will automatically setup the development environment.
0 commit comments