@@ -99,7 +99,7 @@ export PATH=~/Downloads:$PATH >> ~/.bashrc && source ~/.bashrc && source
9999
100100If it returns the version, you’re ready to use the CLI.
101101
102- ::: tip
102+ :::tip Tip
103103
104104If you see an error like:
105105
@@ -114,14 +114,21 @@ This means the Polykey agent is already running. To manage this, you can:
114114polykey agent status
115115```
116116
117+ If the agent returns something like this:
118+
119+ ``` shell
120+ status DEAD
121+ ```
122+ Then the agent is inactive and needs to be restarted. If it returns something other than this, then it is still active.
123+
117124Stop the running agent:
118125
119126``` shell
120127polykey agent stop
121128```
122129
123130You must stop the current agent or use a different terminal before starting a
124- new one.
131+ new one. The currently running agent must be stopped before it can be re-run.
125132
126133:::
127134
@@ -185,7 +192,7 @@ Instructions are provided in the [Source](#source) section.
185192 mv polykey-cli-V.V.V-darwin-universal polykey
186193```
187194
188- ::: tip
195+ :::tip Tip
189196
190197- Navigate into the directory where the file is saved to execute commands.
191198- Replace ` V.V.V. ` with the actual version number of the file you downloaded.
@@ -263,7 +270,8 @@ not appear in the next step. :::
263270sudo ./polykey
264271```
265272
266- :::tip When prompted in the terminal, type your administrator password and hit
273+ :::tip Tip
274+ When prompted in the terminal, type your administrator password and hit
267275enter. :::
268276
2692775 . Following this, you will get another similar prompt
@@ -272,7 +280,8 @@ enter. :::
272280
273281#### Click on Open and now Polykey-CLI should be running in your terminal window.
274282
275- :::tip You can also verify the version of polykey that was installed with:
283+ :::tip Tip
284+ You can also verify the version of polykey that was installed with:
276285
277286``` sh
278287./polykey --version
@@ -301,7 +310,7 @@ a terminal to restart it.
301310
302311:::
303312
304- ::: tip
313+ :::tip Tip
305314
306315If you see an error like:
307316
@@ -339,7 +348,7 @@ new one.
339348 the ` polykey ` executable if it's not in the downloads folder. For most users,
340349 this path would be ` ~/Downloads ` .
341350
342- ::: tip
351+ :::tip Tip
343352
344353Make sure you provide the _ path_ to ` polykey ` instead of the actual executable.
345354This is not the path: ` ~/Downloads/polykey ` . This is the correct path:
@@ -354,7 +363,7 @@ This is not the path: `~/Downloads/polykey`. This is the correct path:
354363</TabItem >
355364 <TabItem value =" bash " label =" Bash " >
356365
357- ::: tip
366+ :::tip Tip
358367
359368The path export should not pint to the Polykey executable itself, but rather to
360369the directory containing the executable. Otherwise, the executable will not be
@@ -370,7 +379,7 @@ found and will not work.
370379 "polykey" if the executable is not in the downloads folder. For most users,
371380 this would be ` ~/Downloads `
372381
373- ::: tip
382+ :::tip Tip
374383
375384Make sure your path to the "polykey" executable is correct. Replace ` downloads `
376385with the path to the working directory
@@ -384,7 +393,7 @@ export PATH=~/downloads:$PATH >> ~/.bashrc && source ~/.bashrc
384393</TabItem >
385394</Tabs >
386395
387- ::: tip
396+ :::tip Tip
388397
389398You can check if the PATH environment variable for Polykey has been updated
390399correctly by running:
@@ -434,7 +443,7 @@ docker run -it "$image"
434443
435444### Docker for Mac
436445
437- ::: tip
446+ :::tip Tip
438447
439448You can install nix for MacOS and then follow the general docker instructions
440449above. Nix for mac can be installed by running
@@ -494,7 +503,7 @@ a terminal to restart it.
494503
495504:::
496505
497- ::: tip
506+ :::tip Tip
498507
499508If you see an error like:
500509
@@ -571,7 +580,7 @@ git clone https://github.com/MatrixAI/Polykey-CLI.git
571580
572581Use `npm install` to setup the project.
573582
574- :::tip
583+ :::tip Tip
575584
576585If you have `nix` installed and `nix-shell` available, enter into `nix-shell`
577586and it will automatically setup the development environment.
0 commit comments