Skip to content

Update CLI installation to use uv tool install openhands - #110

Merged
xingyaoww merged 3 commits into
mainfrom
update-cli-install-uv-tool
Nov 18, 2025
Merged

Update CLI installation to use uv tool install openhands#110
xingyaoww merged 3 commits into
mainfrom
update-cli-install-uv-tool

Conversation

@xingyaoww

Copy link
Copy Markdown
Contributor

Summary

This PR updates the CLI installation documentation to recommend using uv tool install openhands instead of uvx --python 3.12 openhands.

Changes

  • Installation: Changed from uvx --python 3.12 openhands to uv tool install openhands
  • Usage: Simplified to just openhands or openhands serve after installation
  • Upgrade: Added instructions for uv tool upgrade openhands
  • Removed: Shell aliases accordion (no longer necessary with uv tool install)

Benefits

  • More efficient: Avoids re-downloading and rebuilding each time
  • Easier to upgrade: Simple uv tool upgrade openhands command
  • Cleaner usage: Command is available system-wide as openhands after installation

Files Modified

  • openhands/usage/run-openhands/cli-mode.mdx
  • openhands/usage/run-openhands/local-setup.mdx
  • openhands/usage/run-openhands/gui-mode.mdx
  • openhands/usage/windows-without-wsl.mdx

@xingyaoww can click here to continue refining the PR

This change updates the CLI installation documentation to recommend using
'uv tool install openhands' instead of 'uvx --python 3.12 openhands'.

Benefits:
- More efficient: avoids re-downloading and rebuilding each time
- Easier to upgrade: users can run 'uv tool upgrade openhands'
- Simpler usage: after installation, just run 'openhands' directly

Updated files:
- openhands/usage/run-openhands/cli-mode.mdx
- openhands/usage/run-openhands/local-setup.mdx
- openhands/usage/run-openhands/gui-mode.mdx
- openhands/usage/windows-without-wsl.mdx
Since 'uv tool install openhands' automatically makes the command available
system-wide as 'openhands', shell aliases are no longer necessary.

@malhotra5 malhotra5 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

Comment thread openhands/usage/run-openhands/gui-mode.mdx Outdated
@xingyaoww
xingyaoww marked this pull request as ready for review November 18, 2025 03:04
@xingyaoww
xingyaoww requested a review from mamoodi as a code owner November 18, 2025 03:04
@xingyaoww
xingyaoww merged commit ab1b4a5 into main Nov 18, 2025
2 checks passed
@xingyaoww
xingyaoww deleted the update-cli-install-uv-tool branch November 18, 2025 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants