From fed1418cec4ade7f3a3bcaa6019199e9d9d6c01c Mon Sep 17 00:00:00 2001 From: CryptoTotalWar Date: Thu, 25 Jul 2024 20:38:36 +0100 Subject: [PATCH] docs: update troubleshooting guide for Polykey agent operations --- .../getting-started/installing-polykey-cli.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/installing-polykey-cli.md b/docs/getting-started/installing-polykey-cli.md index f720caf..62d1466 100644 --- a/docs/getting-started/installing-polykey-cli.md +++ b/docs/getting-started/installing-polykey-cli.md @@ -551,8 +551,26 @@ polykey agent stop :::info -If you encounter issues with starting or stopping the Polykey agent, try the following: +#### Issues with Starting the Polykey Agent: -- **Ensure the agent is not already running:** Use polykey agent status to check the current status. +- **Check for Existing Agent Instances:** Before starting a new agent, ensure there isn't already one running by executing: -- **Force quit the agent:** If the agent does not terminate properly, use the Activity Monitor or equivalent process management tool on your operating system. +```pkcli +polykey agent status +``` + +#### Issues with Stopping the Polykey Agent: + +- **Force Termination:** If the Polykey agent does not terminate properly, use Activity Monitor (macOS), Task Manager (Windows), or system monitor tools (Linux) to forcefully end the process. + +#### Errors on Agent Start: + +- **Seek Help:** If your Polykey agent fails to start due to an error, please reach out on our [Discord Server](https://discord.gg/vfXQZwwugc) and [submit a bug report](https://github.com/MatrixAI/Polykey-CLI/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=) detailing the issue. + +To assist in diagnosing the issue, please include the verbose output from your terminal. Run the Polykey agent with the verbose flag: + +```pkcli +polykey agent start --verbose +``` + +:::