1- import Tabs from '@theme/Tabs '; import TabItem from '@theme/TabItem '; import
2- Admonition from '@theme/Admonition ';
1+ import Tabs from '@theme/Tabs '; import TabItem from '@theme/TabItem ';
32
43# Installation
54
@@ -56,26 +55,30 @@ directly via the terminal using a prebuilt binary.
5655
5756 ``` sh
5857 chmod u+x ./polykey
59-
6058 ```
6159
62603 . Move it into a directory in your
6361 $PATH, or add the current directory to your
6462 $PATH temporarily:
6563
66- 4 . Confirm the installation:
64+ 4 . Confirm the installation:
65+
66+ ``` sh
6767 polykey --version
68+ ```
6869
69705 . If it returns the version, you’re ready to use the CLI.
7071
71- <Admonition type =" tip " title =" Important: Agent behavior " >
72- Once you start a long‑lived command like <code >polykey agent start</code >, that process monopolizes the current terminal window.
73- To issue any further Polykey commands (for example, <code >polykey vaults
74- create</code >), you must open a ** new terminal window** .
72+ :::important Important
7573
76- If the machine reboots or the agent exits, simply rerun <code >polykey agent
77- start</code > in a terminal to restart it.
78- </Admonition >
74+ Once you start a long‑lived command like ` polykey agent start ` , that process
75+ monopolizes the current terminal window. To issue any further Polykey commands
76+ (for example, ` polykey vaults create ` ), you must open a ** new terminal window** .
77+
78+ If the machine reboots or the agent exits, simply rerun ` polykey agent start ` in
79+ a terminal to restart it.
80+
81+ :::
7982
8083- For ZSH:
8184
@@ -89,7 +92,10 @@ export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
8992export PATH=~ /Downloads:$PATH >> ~ /.bashrc && source ~ /.bashrc && source
9093```
9194
92- 4 . Confirm the installation: polykey --version
95+ 4 . Confirm the installation:
96+ ``` sh
97+ polykey --version
98+ ```
9399
94100If it returns the version, you’re ready to use the CLI.
95101
@@ -210,10 +216,8 @@ trigger a pop-up.
210216
2112171 . MacOS will then prompt you with the following:
212218
213- ::: important
214- Do not close this prompt. If you do, the 'Allow Anyway' option will
215- not appear in the next step.
216- :::
219+ :::important Do not close this prompt. If you do, the 'Allow Anyway' option will
220+ not appear in the next step. :::
217221
218222![ install1] ( /images/mac-install1.png )
219223
@@ -231,10 +235,8 @@ not appear in the next step.
231235sudo ./polykey
232236```
233237
234- ::: tip
235- When prompted in the terminal, type your administrator password and hit
236- enter.
237- :::
238+ :::tip When prompted in the terminal, type your administrator password and hit
239+ enter. :::
238240
2392415 . Following this, you will get another similar prompt
240242
@@ -260,31 +262,34 @@ enter.
260262To enable running the Polykey CLI from any directory in the terminal on macOS,
261263you'll need to update your shell configuration file.
262264
263- <Admonition type =" tip " title =" Important: Agent behavior " >
264- Once you start a long‑lived command like <code >polykey agent start</code >, that process monopolizes the current terminal window.
265+ :::important Important
265266
266- To issue any further Polykey commands (for example, <code >polykey vaults
267- create</code >), you must open a ** new terminal window** .
267+ Once you start a long‑lived command like ` polykey agent start ` , that process
268+ monopolizes the current terminal window. To issue any further Polykey commands
269+ (for example, ` polykey vaults create ` ), you must open a ** new terminal window** .
268270
269- If the machine reboots or the agent exits, simply rerun <code >polykey agent
270- start</code > in a terminal to restart it.
271- </Admonition >
271+ If the machine reboots or the agent exits, simply rerun ` polykey agent start ` in
272+ a terminal to restart it.
273+
274+ :::
272275
273276<Tabs >
274277 <TabItem value="zsh" label="ZSH (default shell on recent macOS versions)">
275278
276279#### For ZSH (default shell on recent macOS versions):
277280
278- 1 . Navigate (cd) into the directory where the " polykey" executable is stored.
281+ 1 . Navigate (cd) into the directory where the ` polykey ` executable is stored.
279282
280- 2 . Edit the Zsh configuration file to add " polykey" to your $PATH. Use the
281- following command, ensuring to replace ~ /Downloads with the correct path to
282- the " polykey" executable if it's not in the downloads folder. For most users,
283- this path would be ~ /Downloads on Debian-based systems .
283+ 2 . Edit the Zsh configuration file to add ` polykey ` to your ` $PATH ` . Use the
284+ following command, ensuring to replace ` ~/Downloads ` with the correct path to
285+ the ` polykey ` executable if it's not in the downloads folder. For most users,
286+ this path would be ` ~/Downloads ` .
284287
285288::: tip
286289
287- Make sure your path to the "polykey" executable is correct.
290+ Make sure you provide the _ path_ to ` polykey ` instead of the actual executable.
291+ This is not the path: ` ~/Downloads/polykey ` . This is the correct path:
292+ ` ~/Downloads ` .
288293
289294:::
290295
@@ -424,15 +429,16 @@ polykey-cli-0.1.2-alpha.2 gygbx1qgpnhbvbcbaby3sfm19bamg7sx 0e1addd9855a 12
424429docker run -it 0e1addd9855a agent start --background -np /tmp/polykey
425430` ` `
426431
427- < Admonition type=" tip" title=" Important: Agent behavior" >
428- Once you start a long‑lived command like < code> polykey agent start< /code> , that process monopolizes the current terminal window.
432+ :::important Important
429433
430- To issue any further Polykey commands (for example, < code> polykey vaults
431- create< /code> ), you must open a ** new terminal window** .
434+ Once you start a long‑lived command like ` polykey agent start` , that process
435+ monopolizes the current terminal window. To issue any further Polykey commands
436+ (for example, ` polykey vaults create` ), you must open a ** new terminal window** .
432437
433- If the machine reboots or the agent exits, simply rerun < code> polykey agent
434- start< /code> in a terminal to restart it.
435- < /Admonition>
438+ If the machine reboots or the agent exits, simply rerun ` polykey agent start` in
439+ a terminal to restart it.
440+
441+ :::
436442
437443Making sure to replace ` 0e1addd9855a` with your corresponding image ID.
438444
@@ -447,7 +453,7 @@ clientHost 127.0.0.1
447453clientPort 45509
448454agentHost ::
449455agentPort 37468
450- recoveryCode (random text recovery code goes here)
456+ recoveryCode (random recovery code goes here)
451457
452458```
453459
@@ -487,8 +493,8 @@ Use `npm install` to setup the project.
487493
488494:::tip
489495
490- If you have `nix-shell` available, enter into `nix-shell` and it will
491- automatically setup the development environment.
496+ If you have `nix` installed and `nix -shell` available, enter into `nix-shell`
497+ and it will automatically setup the development environment.
492498
493499:::
494500
0 commit comments