Skip to content

Commit 72428a7

Browse files
tegefaulkestegefaulkes
committed
docs: regenerating docs
1 parent ddd5a2b commit 72428a7

File tree

165 files changed

+9884
-654
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+9884
-654
lines changed

‎docs/assets/highlight.css‎

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
:root {
2-
--light-hl-0: #001080;
3-
--dark-hl-0: #9CDCFE;
2+
--light-hl-0: #795E26;
3+
--dark-hl-0: #DCDCAA;
44
--light-hl-1: #000000;
55
--dark-hl-1: #D4D4D4;
66
--light-hl-2: #A31515;
77
--dark-hl-2: #CE9178;
8-
--light-hl-3: #795E26;
9-
--dark-hl-3: #DCDCAA;
10-
--light-hl-4: #0000FF;
11-
--dark-hl-4: #569CD6;
12-
--light-hl-5: #EE0000;
13-
--dark-hl-5: #D7BA7D;
14-
--light-hl-6: #008000;
15-
--dark-hl-6: #6A9955;
8+
--light-hl-3: #0000FF;
9+
--dark-hl-3: #569CD6;
10+
--light-hl-4: #001080;
11+
--dark-hl-4: #9CDCFE;
12+
--light-hl-5: #008000;
13+
--dark-hl-5: #6A9955;
1614
--light-code-background: #FFFFFF;
1715
--dark-code-background: #1E1E1E;
1816
}
@@ -24,7 +22,6 @@
2422
--hl-3: var(--light-hl-3);
2523
--hl-4: var(--light-hl-4);
2624
--hl-5: var(--light-hl-5);
27-
--hl-6: var(--light-hl-6);
2825
--code-background: var(--light-code-background);
2926
} }
3027

@@ -35,7 +32,6 @@
3532
--hl-3: var(--dark-hl-3);
3633
--hl-4: var(--dark-hl-4);
3734
--hl-5: var(--dark-hl-5);
38-
--hl-6: var(--dark-hl-6);
3935
--code-background: var(--dark-code-background);
4036
} }
4137

@@ -46,7 +42,6 @@
4642
--hl-3: var(--light-hl-3);
4743
--hl-4: var(--light-hl-4);
4844
--hl-5: var(--light-hl-5);
49-
--hl-6: var(--light-hl-6);
5045
--code-background: var(--light-code-background);
5146
}
5247

@@ -57,7 +52,6 @@
5752
--hl-3: var(--dark-hl-3);
5853
--hl-4: var(--dark-hl-4);
5954
--hl-5: var(--dark-hl-5);
60-
--hl-6: var(--dark-hl-6);
6155
--code-background: var(--dark-code-background);
6256
}
6357

@@ -67,5 +61,4 @@
6761
.hl-3 { color: var(--hl-3); }
6862
.hl-4 { color: var(--hl-4); }
6963
.hl-5 { color: var(--hl-5); }
70-
.hl-6 { color: var(--hl-6); }
7164
pre, code { background: var(--code-background); }

‎docs/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/CommandPolykey.html‎

Lines changed: 95 additions & 92 deletions
Large diffs are not rendered by default.

‎docs/classes/agent.default.html‎

Lines changed: 21 additions & 18 deletions
Large diffs are not rendered by default.

‎docs/classes/bootstrap.default.html‎

Lines changed: 23 additions & 20 deletions
Large diffs are not rendered by default.

‎docs/classes/errors.ErrorPolykeyCLI.html‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ <h4>Hierarchy</h4>
3737
<ul class="tsd-hierarchy">
3838
<li><a href="errors.ErrorPolykeyCLIUncaughtException.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIUncaughtException</a></li>
3939
<li><a href="errors.ErrorPolykeyCLIUnhandledRejection.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIUnhandledRejection</a></li>
40+
<li><a href="errors.ErrorPolykeyCLIUnexpectedError.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIUnexpectedError</a></li>
41+
<li><a href="errors.ErrorPolykeyCLIChildProcessFailure.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIChildProcessFailure</a></li>
4042
<li><a href="errors.ErrorPolykeyCLIAsynchronousDeadlock.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIAsynchronousDeadlock</a></li>
4143
<li><a href="errors.ErrorPolykeyCLINodePath.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLINodePath</a></li>
4244
<li><a href="errors.ErrorPolykeyCLIClientOptions.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIClientOptions</a></li>
@@ -50,7 +52,15 @@ <h4>Hierarchy</h4>
5052
<li><a href="errors.ErrorPolykeyCLIAgentStatus.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIAgentStatus</a></li>
5153
<li><a href="errors.ErrorPolykeyCLIAgentProcess.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIAgentProcess</a></li>
5254
<li><a href="errors.ErrorPolykeyCLINodeFindFailed.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLINodeFindFailed</a></li>
53-
<li><a href="errors.ErrorPolykeyCLINodePingFailed.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLINodePingFailed</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
55+
<li><a href="errors.ErrorPolykeyCLINodePingFailed.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLINodePingFailed</a></li>
56+
<li><a href="errors.ErrorPolykeyCLIInvalidEnvName.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIInvalidEnvName</a></li>
57+
<li><a href="errors.ErrorPolykeyCLIDuplicateEnvName.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIDuplicateEnvName</a></li>
58+
<li><a href="errors.ErrorPolykeyCLIMakeDirectory.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIMakeDirectory</a></li>
59+
<li><a href="errors.ErrorPolykeyCLIRenameSecret.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIRenameSecret</a></li>
60+
<li><a href="errors.ErrorPolykeyCLIRemoveSecret.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIRemoveSecret</a></li>
61+
<li><a href="errors.ErrorPolykeyCLICatSecret.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLICatSecret</a></li>
62+
<li><a href="errors.ErrorPolykeyCLIEditSecret.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLIEditSecret</a></li>
63+
<li><a href="errors.ErrorPolykeyCLITouchSecret.html" class="tsd-signature-type tsd-kind-class">ErrorPolykeyCLITouchSecret</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
5464
<ul>
5565
<li>Defined in <a href="https://github.com/MatrixAI/Polykey-CLI/blob/master/src/errors.ts#L11">src/errors.ts:11</a></li></ul></aside>
5666
<section class="tsd-panel-group tsd-index-group">
@@ -316,8 +326,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
316326
<li><a href="errors.ErrorPolykeyCLIAgentProcess.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIAgent<wbr/>Process</span></a></li>
317327
<li><a href="errors.ErrorPolykeyCLIAgentStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIAgent<wbr/>Status</span></a></li>
318328
<li><a href="errors.ErrorPolykeyCLIAsynchronousDeadlock.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIAsynchronous<wbr/>Deadlock</span></a></li>
329+
<li><a href="errors.ErrorPolykeyCLICatSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLICat<wbr/>Secret</span></a></li>
330+
<li><a href="errors.ErrorPolykeyCLIChildProcessFailure.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIChild<wbr/>Process<wbr/>Failure</span></a></li>
319331
<li><a href="errors.ErrorPolykeyCLIClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIClient<wbr/>Options</span></a></li>
332+
<li><a href="errors.ErrorPolykeyCLIDuplicateEnvName.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIDuplicate<wbr/>Env<wbr/>Name</span></a></li>
333+
<li><a href="errors.ErrorPolykeyCLIEditSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIEdit<wbr/>Secret</span></a></li>
320334
<li><a href="errors.ErrorPolykeyCLIFileRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIFile<wbr/>Read</span></a></li>
335+
<li><a href="errors.ErrorPolykeyCLIInvalidEnvName.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIInvalid<wbr/>Env<wbr/>Name</span></a></li>
336+
<li><a href="errors.ErrorPolykeyCLIMakeDirectory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIMake<wbr/>Directory</span></a></li>
321337
<li><a href="errors.ErrorPolykeyCLINodeFindFailed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLINode<wbr/>Find<wbr/>Failed</span></a></li>
322338
<li><a href="errors.ErrorPolykeyCLINodePath.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLINode<wbr/>Path</span></a></li>
323339
<li><a href="errors.ErrorPolykeyCLINodePingFailed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLINode<wbr/>Ping<wbr/>Failed</span></a></li>
@@ -327,7 +343,11 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
327343
<li><a href="errors.ErrorPolykeyCLIPrivateKeyFileRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIPrivate<wbr/>Key<wbr/>File<wbr/>Read</span></a></li>
328344
<li><a href="errors.ErrorPolykeyCLIPublicJWKFileRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIPublicJWKFile<wbr/>Read</span></a></li>
329345
<li><a href="errors.ErrorPolykeyCLIRecoveryCodeFileRead.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIRecovery<wbr/>Code<wbr/>File<wbr/>Read</span></a></li>
346+
<li><a href="errors.ErrorPolykeyCLIRemoveSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIRemove<wbr/>Secret</span></a></li>
347+
<li><a href="errors.ErrorPolykeyCLIRenameSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIRename<wbr/>Secret</span></a></li>
348+
<li><a href="errors.ErrorPolykeyCLITouchSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLITouch<wbr/>Secret</span></a></li>
330349
<li><a href="errors.ErrorPolykeyCLIUncaughtException.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIUncaught<wbr/>Exception</span></a></li>
350+
<li><a href="errors.ErrorPolykeyCLIUnexpectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIUnexpected<wbr/>Error</span></a></li>
331351
<li><a href="errors.ErrorPolykeyCLIUnhandledRejection.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Error<wbr/>PolykeyCLIUnhandled<wbr/>Rejection</span></a></li></ul></div></details></li>
332352
<li><a href="../modules/identities.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>identities</span></a></li>
333353
<li><a href="../modules/keys.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>keys</span></a></li>
@@ -337,10 +357,13 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
337357
<li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>utils</span></a></li>
338358
<li><a href="../modules/vaults.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>vaults</span></a></li>
339359
<li><a href="CommandPolykey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Command<wbr/>Polykey</span></a></li>
340-
<li><a href="../interfaces/TableOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Table<wbr/>Options</span></a></li>
360+
<li><a href="../interfaces/DictOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Dict<wbr/>Options</span></a></li>
361+
<li><a href="../interfaces/TableOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Table<wbr/>Options</span></a></li>
341362
<li><a href="../types/AgentChildProcessInput.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Agent<wbr/>Child<wbr/>Process<wbr/>Input</span></a></li>
342363
<li><a href="../types/AgentChildProcessOutput.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Agent<wbr/>Child<wbr/>Process<wbr/>Output</span></a></li>
343364
<li><a href="../types/AgentStatusLiveData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Agent<wbr/>Status<wbr/>Live<wbr/>Data</span></a></li>
365+
<li><a href="../types/ParsedSecretPathValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Parsed<wbr/>Secret<wbr/>Path<wbr/>Value</span></a></li>
366+
<li><a href="../types/PromiseDeconstructed.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Promise<wbr/>Deconstructed</span></a></li>
344367
<li><a href="../types/TableRow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Row</span></a></li>
345368
<li><a href="../functions/polykey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>polykey</span></a></li></ul></nav></div></div></div>
346369
<div class="tsd-generator">

0 commit comments

Comments
 (0)