Update CLI documentation with new features since v1.2.0#190
Update CLI documentation with new features since v1.2.0#190jpelletier1 wants to merge 3 commits intomainfrom
Conversation
- Add experimental UI documentation (--exp flag) with dark mode, spinners, file search - Document new CLI options: --task, --file, --version, --headless, --always-approve, --llm-approve - Add ACP integration documentation and enhanced slash commands - Document automatic skills loading (project, user, public skills) - Add /condense command for memory management - Update installation links to OpenHands-CLI repository - Enhance CLI settings page with approval modes and confirmation options Co-authored-by: openhands <openhands@all-hands.dev>
|
@OpenHands under the CLI page, move the "Example Usage" section to the Headless page. Then, the first section on the Headless page should be "With CLI", and use the example usage section there. Make sure to include --headless command in those examples. |
|
I'm on it! jpelletier1 can track my progress at all-hands.dev |
- Moved Example Usage section from CLI page to Headless page - Created 'With CLI' as the first section on Headless page - Added --headless flag to all examples in the moved section - Added additional CLI headless options documentation Co-authored-by: openhands <openhands@all-hands.dev>
SummaryI have successfully completed your request to reorganize the CLI documentation. Here's what was accomplished: ✅ Request Completion Checklist:
📝 Changes Made:
🚀 Result:The documentation now properly separates interactive CLI usage from headless/scripting usage, with all headless examples consolidated on the Headless page and properly flagged with The reorganization makes the documentation more logical and user-friendly, clearly distinguishing between interactive CLI usage and headless automation scenarios. |
|
@malhotra5 i tried to update the docs based on latest changes. LMK if i missed anything (maybe openhands login?) |
Summary of changes
This PR updates the OpenHands CLI documentation to reflect all the significant new features and improvements added since version 1.2.0, based on analysis of releases 1.3.0 through 1.5.0.
Key Features Documented
🎨 Experimental UI (v1.5.0)
--expflag for enhanced terminal experience@macro⚙️ New CLI Options
--task "message"- Start CLI with initial task--file path/to/file- Start with specific file context--version/-v- Display CLI version--headless- Run in headless mode with auto-exit--always-approve- Automatically approve all actions--llm-approve- Use LLM for intelligent action approval--exit-without-confirmation- Exit without prompts🤖 Enhanced Features
/condensecommand for conversation history optimizationDocumentation Changes
Updated Files
cli-mode.mdx: Added comprehensive sections for new CLI options, experimental UI features, skills integration, and version managementcli-settings.mdx: Enhanced with ACP integration, new slash commands, approval modes, and memory managementdocs.json: Updated navigation structureImprovements
The documentation now provides users with comprehensive guidance on using all the latest CLI capabilities, from basic usage to advanced automation scenarios with the experimental UI and ACP integration.
@jpelletier1 can click here to continue refining the PR