Skip to content

Commit 35a1d4c

Browse files
committed
docs: lint fixes
1 parent ef0a05e commit 35a1d4c

File tree

1 file changed

+48
-31
lines changed

1 file changed

+48
-31
lines changed

docs/Getting-Started/polykey-cli/installation.md

Lines changed: 48 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -68,38 +68,31 @@ directly via the terminal using a prebuilt binary.
6868

6969
5. If it returns the version, you’re ready to use the CLI.
7070

71-
<Admonition type="tip" title="Important — Agent behavior">
71+
<Admonition type="tip" title="Important: Agent behavior">
7272
Once you start a long‑lived command like <code>polykey agent start</code>, that process monopolizes the current terminal window.
73-
7473
To issue any further Polykey commands (for example, <code>polykey vaults
7574
create</code>), you must open a **new terminal window**.
7675

7776
If the machine reboots or the agent exits, simply rerun <code>polykey agent
78-
start</code> in a terminal to restart it. </Admonition> 66. --- 67. ### NixOS
77+
start</code> in a terminal to restart it.
78+
</Admonition>
7979

8080
- For ZSH:
8181

82-
echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
82+
```shell
83+
export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
84+
```
8385

84-
- For Bash: echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source
85-
~/.bashrc
86+
- For Bash:
87+
88+
```shell
89+
export PATH=~/Downloads:$PATH >> ~/.bashrc && source ~/.bashrc && source
90+
```
8691

8792
4. Confirm the installation: polykey --version
8893

8994
If it returns the version, you’re ready to use the CLI.
9095

91-
:::tip Important: Agent behavior
92-
93-
Once you start the Polykey agent, the terminal window will be fully occupied by
94-
the running agent process.
95-
96-
To continue issuing Polykey commands (e.g., to create a vault), you must open a
97-
**new terminal window**.
98-
If the system shuts down or the agent process stops, you’ll need to **restart
99-
the agent** before running any other commands.
100-
101-
:::
102-
10396
### NixOS
10497

10598
We have not yet published a Nix package for Polykey. When we do, you will be
@@ -127,7 +120,7 @@ $ nix-env -f ./release.nix --install --attr application --argstr npmDepsHash "$(
127120

128121
### Other
129122

130-
We will be working on other distribution methods.
123+
We are working on other distribution methods. Check back soon.
131124

132125
</TabItem>
133126
<TabItem value="macOS" label="MacOS">
@@ -165,7 +158,7 @@ this guide below to manually build and install Polykey on macOS.
165158

166159
:::
167160

168-
3. Make the Executable Runnable: Before you can run the Polykey CLI, you need to
161+
3. Make the file Executable: Before you can run the Polykey CLI, you need to
169162
make it executable. Use the `chmod +x` command to add executable permissions
170163
to the file. Replace `polykey` with the actual name of your file if it's
171164
different:
@@ -196,7 +189,7 @@ Remember to ensure that the file path matches the location of your polykey file.
196189
sudo xattr -r -d com.apple.quarantine ~/Downloads/polykey
197190
```
198191

199-
If you have completed this sucesfully, you may ignore Method #2 and move to the
192+
If you have completed this sucessfully, you may ignore Method #2 and move to the
200193
next section on how to add polykey to your `$PATH`.
201194

202195
## <!-- I need to add a link to skip ahead -->
@@ -217,8 +210,10 @@ trigger a pop-up.
217210

218211
1. MacOS will then prompt you with the following:
219212

220-
:::important Do not close this prompt. If you do, the 'Allow Anyway' option will
221-
not appear in the next step. :::
213+
:::important
214+
Do not close this prompt. If you do, the 'Allow Anyway' option will
215+
not appear in the next step.
216+
:::
222217

223218
![install1](/images/mac-install1.png)
224219

@@ -236,8 +231,10 @@ not appear in the next step. :::
236231
sudo ./polykey
237232
```
238233

239-
:::tip When prompted in the terminal, type your administrator password and hit
240-
enter. :::
234+
:::tip
235+
When prompted in the terminal, type your administrator password and hit
236+
enter.
237+
:::
241238

242239
5. Following this, you will get another similar prompt
243240

@@ -263,6 +260,16 @@ enter. :::
263260
To enable running the Polykey CLI from any directory in the terminal on macOS,
264261
you'll need to update your shell configuration file.
265262

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+
266+
To issue any further Polykey commands (for example, <code>polykey vaults
267+
create</code>), you must open a **new terminal window**.
268+
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>
272+
266273
<Tabs>
267274
<TabItem value="zsh" label="ZSH (default shell on recent macOS versions)">
268275

@@ -281,8 +288,8 @@ Make sure your path to the "polykey" executable is correct.
281288

282289
:::
283290

284-
```sh
285-
echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
291+
```shell
292+
'export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
286293
```
287294
288295
</TabItem>
@@ -309,12 +316,12 @@ found and will not work.
309316
Make sure your path to the "polykey" executable is correct. Replace `downloads`
310317
with the path to the working directory
311318
312-
:::
313-
314-
```sh
315-
echo 'export PATH=~/downloads:$PATH' >> ~/.bashrc && source ~/.bashrc
319+
```shell
320+
export PATH=~/downloads:$PATH >> ~/.bashrc && source ~/.bashrc
316321
```
317322
323+
:::
324+
318325
</TabItem>
319326
</Tabs>
320327
@@ -417,6 +424,16 @@ polykey-cli-0.1.2-alpha.2 gygbx1qgpnhbvbcbaby3sfm19bamg7sx 0e1addd9855a 12
417424
docker run -it 0e1addd9855a agent start --background -np /tmp/polykey
418425
```
419426

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.
429+
430+
To issue any further Polykey commands (for example, <code>polykey vaults
431+
create</code>), you must open a **new terminal window**.
432+
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>
436+
420437
Making sure to replace `0e1addd9855a` with your corresponding image ID.
421438

422439
```shell

0 commit comments

Comments
 (0)