CLI(V1): New project docs #5
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update uvx commands to use simplified 'openhands' instead of '--from openhands-ai openhands' - Change pip install commands from 'openhands-ai' to 'openhands' - Update shell aliases and installation examples across documentation - Sync with changes from OpenHands PR #11271 Co-authored-by: openhands <openhands@all-hands.dev>
malhotra5
changed the title
malhotra5
commented
Oct 7, 2025
- Restructure Getting Started section to prioritize executable binary - Move uv and pip methods to accordion alternatives - Simplify instructions and remove verbose explanations
- Change page title from 'CLI' to 'CLI (V1)' - Add note about settings migration for users upgrading from pre-1.X.X versions
- Remove /init command from available commands table - Remove Repository Initialization section as the command is not currently available
- Change settings reference from config.toml to ~/.openhands/settings.json - Change MCP configuration reference from config.toml to ~/.openhands/mcp.json - Remove outdated TOML configuration example and search_api_key reference
- Change /mcp command description to indicate read-only status viewing - Update MCP Server Management section to clarify manual configuration requirement - Reference gofastmcp.com configuration format documentation - Remove references to interactive MCP server management
- Add note about MCP configuration migration from TOML to JSON format - Inform users they need to redo MCP settings when upgrading from pre-1.X.X versions
- Remove note about running CLI with Poetry for cloned repository - Simplify installation instructions by focusing on primary methods
- Remove note about migrating ~/.openhands-state to ~/.openhands - Clean up outdated version-specific migration instructions
- Change conversation history location from ~/.openhands/sessions to ~/.openhands/conversations - Update only the Getting Started section as requested
- Switch from openhands runtime image to python:3.12-slim base image - Install CLI via uv package manager inside container - Adjust volume mount from /.openhands to /root/.openhands for proper settings location - Remove LLM_API_KEY and LLM_MODEL environment variables (settings now from JSON) - Update container name to openhands-cli for clarity - Simplify environment variable setup instructions
- Add step to ensure settings.json is configured before running Docker command - Include optional mcp.json configuration note - Update step numbering to accommodate new configuration step
mamoodi
reviewed
Oct 7, 2025
mamoodi
reviewed
Oct 7, 2025
mamoodi
reviewed
Oct 7, 2025
Collaborator
|
Generally looks good. Some questions/comments. |
malhotra5
commented
Oct 7, 2025
Co-authored-by: openhands <openhands@all-hands.dev>
malhotra5
commented
Oct 10, 2025
enyst
pushed a commit
that referenced
this pull request
Nov 8, 2025
Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the docs for V1 CLI. It includes
Fixes APP-32