Skip to content

docs: add Linux CLI terminal installation instructions and clean up outdated steps #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
May 12, 2025

Conversation

xrissoula
Copy link
Contributor

@xrissoula xrissoula commented May 4, 2025

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
@aryanjassal aryanjassal changed the title docs: add Linux CLI terminal installation instructions and clean up o… docs: add Linux CLI terminal installation instructions and clean up outdated steps May 5, 2025
@xrissoula
Copy link
Contributor Author

The PR is failing due to a lint.mjs shellcheck step that uses find -regextype, which isn’t supported on macOS or the default GitHub runner. No .sh files were added or changed in this PR, so this isn’t related to the actual changes. @CMCDragonkai @aryanjassal

@aryanjassal
Copy link
Member

I guess a platform-agnostic way to do this could be this? I'll have to dig into this later.

find ./src ./scripts -type f | grep -E '\\.sh$' | xargs shellcheck

@aryanjassal
Copy link
Member

Actually nevermind, that is not the issue. We use nix wrappers in the CI so that wouldn't be an issue. If we look at the error, this is buried between the error somewhere.

Checking formatting...
[warn] docs/Getting-Started/polykey-cli/installation.md
[warn] Code style issues found in the above file. Run Prettier with --write to fix.

It says that prettier found some code issues so you gotta fix that instead. Try running npm run lintfix to update all the files. If any changes are observed, then the lint was catching an issue correctly.

Copy link
Member

@aryanjassal aryanjassal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's mostly good, just a minor update

@aryanjassal aryanjassal merged commit 910eca0 into staging May 12, 2025
3 checks passed
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
3 participants