Skip to content

Conversation

@xrissoula
Copy link
Contributor

Description

This PR updates the Polykey CLI installation documentation to:

  • Clean up and streamline the Linux installation steps
  • Clarify terminal behavior when running the polykey agent start command
  • Add onboarding guidance for users interacting with the agent via terminal

This resolves confusion around why subsequent Polykey commands don’t work in the same terminal window after starting the agent, addressing a critical usability gap in the existing CLI documentation.

Issues Fixed

Tasks

  • 1. Remove duplicated and outdated Linux installation instructions
  • 2. Clearly document that the agent takes over the terminal window
  • 3. Instruct users to open a new terminal window to issue further commands (e.g., vault creation)
  • 4. Mention the need to restart the agent if terminated or after reboot
  • 5. more to follow, after receiving feedback from @CMCDragonkai @aryanjassal @faithveloro09

Final checklist

  • Domain specific tests
  • Full tests
  • Updated inline-comment documentation
  • Lint fixed
  • Squash and rebased
  • Sanity check the final build

@xrissoula xrissoula added the documentation Improvements or additions to documentation label May 4, 2025
@xrissoula xrissoula self-assigned this May 4, 2025
@xrissoula xrissoula closed this May 4, 2025
@xrissoula xrissoula reopened this May 4, 2025
@xrissoula
Copy link
Contributor Author

closing and remaking this PR because I created it off of the wrong branch. it is now PR #144

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

Improve CLI and docs to guide users on agent terminal behavior

2 participants