Skip to content

Commit 22eb086

Browse files
committed
docs: clarify agent error handling when already running
1 parent a786b86 commit 22eb086

File tree

1 file changed

+81
-3
lines changed

1 file changed

+81
-3
lines changed

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

Lines changed: 81 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,32 @@ export PATH=~/Downloads:$PATH >> ~/.bashrc && source ~/.bashrc && source
9999

100100
If it returns the version, you’re ready to use the CLI.
101101

102+
:::tip
103+
104+
If you see an error like:
105+
106+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
107+
108+
This means the Polykey agent is already running. To manage this, you can:
109+
110+
- **Check the agent status**:
111+
112+
```shell
113+
polykey agent status
114+
115+
```
116+
117+
Stop the running agent:
118+
119+
```shell
120+
polykey agent stop
121+
```
122+
123+
You must stop the current agent or use a different terminal before starting a new one.
124+
125+
:::
126+
127+
102128
### NixOS
103129

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

136162
:::info
137163

138-
ARM-64 builds are not currently supported on MacOS as of **6 April 2025.**
139-
However, building Polykey yourself on MacOS resolves in a working binary. Follow
140-
this guide below to manually build and install Polykey on macOS.
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).
165+
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.
141167

142168
:::
143169

@@ -273,6 +299,32 @@ a terminal to restart it.
273299

274300
:::
275301

302+
:::tip
303+
304+
If you see an error like:
305+
306+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
307+
308+
This means the Polykey agent is already running. To manage this, you can:
309+
310+
- **Check the agent status**:
311+
312+
```shell
313+
polykey agent status
314+
315+
```
316+
317+
Stop the running agent:
318+
319+
```shell
320+
polykey agent stop
321+
```
322+
323+
You must stop the current agent or use a different terminal before starting a new one.
324+
325+
:::
326+
327+
276328
<Tabs>
277329
<TabItem value="zsh" label="ZSH (default shell on recent macOS versions)">
278330

@@ -440,6 +492,32 @@ a terminal to restart it.
440492

441493
:::
442494

495+
:::tip
496+
497+
If you see an error like:
498+
499+
WARN:polykey.PolykeyAgent:Failed Creating PolykeyAgent — another agent may already be running
500+
501+
This means the Polykey agent is already running. To manage this, you can:
502+
503+
- **Check the agent status**:
504+
505+
```shell
506+
polykey agent status
507+
508+
```
509+
510+
Stop the running agent:
511+
512+
```shell
513+
polykey agent stop
514+
```
515+
516+
You must stop the current agent or use a different terminal before starting a new one.
517+
518+
:::
519+
520+
443521
Making sure to replace `0e1addd9855a` with your corresponding image ID.
444522

445523
```shell

0 commit comments

Comments
 (0)