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/Getting-Started/polykey-cli/bootstrapping.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,13 +26,16 @@ key.
26
26
27
27
:::note Note
28
28
29
-
Remember to keep your password in a secure location as you will need it each time you start the Polykey agent.
29
+
Remember to keep your password in a secure location as you will need it each
30
+
time you start the Polykey agent.
30
31
31
32
:::
32
33
33
34
:::important
34
35
35
-
Bootstrapping also returns a **recovery code**. This code is required to recover a node with the same ID, so it is critical that you store it safely and securely. If lost, node identity recovery will not be possible.
36
+
Bootstrapping also returns a **recovery code**. This code is required to recover
37
+
a node with the same ID, so it is critical that you store it safely and
38
+
securely. If lost, node identity recovery will not be possible.
Copy file name to clipboardExpand all lines: docs/Getting-Started/polykey-cli/claiming-digital-identities.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,9 @@ cryptographic link to a publicly verifiable location.
8
8
9
9
This tutorial will guide you through the steps to authenticate with GitHub and
10
10
claim an identity using Polykey, enhancing security and streamlining identity
11
-
verification, making it easier for other users to discover and trust your nodes. Currently, we only support github as an identity provider, but we plan to add more in the future.
11
+
verification, making it easier for other users to discover and trust your nodes.
12
+
Currently, we only support github as an identity provider, but we plan to add
Copy file name to clipboardExpand all lines: docs/Getting-Started/polykey-cli/installation.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,17 @@ Installing the CLI can be done in different ways depending on your operating
6
6
environment.
7
7
8
8
:::info
9
+
9
10
## Polykey Core Overview
10
11
11
-
The Polykey CLI and core primarily use TypeScript for service logic, domain business operations, and persistence layers. While the main codebase is in TypeScript, some supporting libraries incorporate native C++ or Rust for platform‐specific functionality. This approach combines cross‐platform convenience with native performance optimizations.
12
-
Polykey-CLI has only been tested on Linux and macOS. We are working on
13
-
supporting other platforms. There's minor teething problems when it comes
14
-
supporting other platforms. Help us by reporting any issues with the CLI tool in
15
-
our Github Repo
12
+
The Polykey CLI and core primarily use TypeScript for service logic, domain
13
+
business operations, and persistence layers. While the main codebase is in
14
+
TypeScript, some supporting libraries incorporate native C++ or Rust for
15
+
platform‐specific functionality. This approach combines cross‐platform
16
+
convenience with native performance optimizations. Polykey-CLI has only been
17
+
tested on Linux and macOS. We are working on supporting other platforms. There's
18
+
minor teething problems when it comes supporting other platforms. Help us by
19
+
reporting any issues with the CLI tool in our Github Repo
16
20
[here](https://github.com/MatrixAI/Polykey-CLI/issues/new/choose) or by dropping
17
21
a message to the developers in our discord server
18
22
[here](https://discord.gg/dC32r35TeE).
@@ -134,9 +138,9 @@ We will be working on other distribution methods.
134
138
135
139
:::info
136
140
137
-
ARM-64 builds are not currently supported on MacOS as of **6 April 2025.** However,
138
-
building Polykey yourself on MacOS resolves in a working binary. Follow this
139
-
guide below to manually build and install Polykey on macOS.
141
+
ARM-64 builds are not currently supported on MacOS as of **6 April 2025.**
142
+
However, building Polykey yourself on MacOS resolves in a working binary. Follow
143
+
this guide below to manually build and install Polykey on macOS.
Copy file name to clipboardExpand all lines: docs/Getting-Started/polykey-cli/managing-multiple-nodes.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,10 @@
2
2
3
3
Managing multiple local
4
4
5
-
nodes in Polykey can serve various purposes. For example, you might maintain one node for personal projects and another for professional work. This segregation ensures that the vaults and their respective contents remain distinct based on their usage context.
5
+
nodes in Polykey can serve various purposes. For example, you might maintain one
6
+
node for personal projects and another for professional work. This segregation
7
+
ensures that the vaults and their respective contents remain distinct based on
8
+
their usage context.
6
9
7
10
This approach is particularly advantageous for demonstrations or training
8
11
purposes, as it allows you to simulate sharing vaults between two nodes on the
@@ -40,8 +43,8 @@ context.
40
43
41
44
:::note Note
42
45
43
-
If a node has not been created before, initializing the Polykey agent
44
-
for it will also initiate the bootstrap process.
46
+
If a node has not been created before, initializing the Polykey agent for it
0 commit comments