Skip to content

Commit 5d6f881

Browse files
committed
docs: format fixes
1 parent 22eb086 commit 5d6f881

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

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

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ If it returns the version, you’re ready to use the CLI.
103103

104104
If you see an error like:
105105

106-
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
106+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may
107+
already be running
107108

108109
This means the Polykey agent is already running. To manage this, you can:
109110

110111
- **Check the agent status**:
111112

112113
```shell
113114
polykey agent status
114-
115115
```
116116

117117
Stop the running agent:
@@ -120,11 +120,11 @@ Stop the running agent:
120120
polykey agent stop
121121
```
122122

123-
You must stop the current agent or use a different terminal before starting a new one.
123+
You must stop the current agent or use a different terminal before starting a
124+
new one.
124125

125126
:::
126127

127-
128128
### NixOS
129129

130130
We have not yet published a Nix package for Polykey. When we do, you will be
@@ -161,9 +161,11 @@ We are working on other distribution methods. Check back soon.
161161

162162
:::info
163163

164-
The file `polykey-cli-V.V.V-darwin-universal` is **not truly universal** — it only supports **ARM64-based Macs** (Apple Silicon: M1, M2, M3, etc).
164+
The file `polykey-cli-V.V.V-darwin-universal` is **not truly universal** — it
165+
only supports **ARM64-based Macs** (Apple Silicon: M1, M2, M3, etc).
165166
It **will not** run on Intel-based Macs.
166-
If you're using an Intel Mac, you must **build Polykey from source**. Instructions are provided in the [Source](#source) section.
167+
If you're using an Intel Mac, you must **build Polykey from source**.
168+
Instructions are provided in the [Source](#source) section.
167169

168170
:::
169171

@@ -303,15 +305,15 @@ a terminal to restart it.
303305

304306
If you see an error like:
305307

306-
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
308+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may
309+
already be running
307310

308311
This means the Polykey agent is already running. To manage this, you can:
309312

310313
- **Check the agent status**:
311314

312315
```shell
313316
polykey agent status
314-
315317
```
316318

317319
Stop the running agent:
@@ -320,11 +322,11 @@ Stop the running agent:
320322
polykey agent stop
321323
```
322324

323-
You must stop the current agent or use a different terminal before starting a new one.
325+
You must stop the current agent or use a different terminal before starting a
326+
new one.
324327

325328
:::
326329

327-
328330
<Tabs>
329331
<TabItem value="zsh" label="ZSH (default shell on recent macOS versions)">
330332

@@ -346,7 +348,7 @@ This is not the path: `~/Downloads/polykey`. This is the correct path:
346348
:::
347349

348350
```shell
349-
'export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
351+
export PATH=~/Downloads:$PATH >> ~/.zshrc && source ~/.zshrc
350352
```
351353

352354
</TabItem>
@@ -403,7 +405,7 @@ terminal.
403405
:::warning
404406

405407
Polykey for windows should be working but we have yet to create documentation on
406-
the installation process for this.
408+
the installation process for this. Check back soon.
407409

408410
:::
409411

@@ -496,15 +498,15 @@ a terminal to restart it.
496498

497499
If you see an error like:
498500

499-
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
501+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may
502+
already be running
500503

501504
This means the Polykey agent is already running. To manage this, you can:
502505

503506
- **Check the agent status**:
504507

505508
```shell
506509
polykey agent status
507-
508510
```
509511

510512
Stop the running agent:
@@ -513,11 +515,11 @@ Stop the running agent:
513515
polykey agent stop
514516
```
515517

516-
You must stop the current agent or use a different terminal before starting a new one.
518+
You must stop the current agent or use a different terminal before starting a
519+
new one.
517520

518521
:::
519522

520-
521523
Making sure to replace `0e1addd9855a` with your corresponding image ID.
522524

523525
```shell

0 commit comments

Comments
 (0)