Skip to content

Conversation

@jpelletier1
Copy link
Contributor

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

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)

  • New --exp flag for enhanced terminal experience
  • Dark mode override for consistent UI across terminals
  • Loading spinners for long-running commands
  • Smart prompt queuing while agent is running
  • File search functionality with @ macro
  • Collapsible messages to reduce verbosity
  • Improved multi-line input handling

⚙️ 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

  • ACP Integration: Agent Computer Protocol support with enhanced session management
  • Skills System: Automatic loading of project, user, and public skills
  • Memory Management: New /condense command for conversation history optimization
  • Version Management: Automatic update checking and prompts

Documentation Changes

Updated Files

  • cli-mode.mdx: Added comprehensive sections for new CLI options, experimental UI features, skills integration, and version management
  • cli-settings.mdx: Enhanced with ACP integration, new slash commands, approval modes, and memory management
  • docs.json: Updated navigation structure

Improvements

  • ✅ Complete coverage of all new features since v1.2.0
  • ✅ Practical examples and use cases for each feature
  • ✅ Clear organization separating basic usage from advanced features
  • ✅ Updated installation links to point to OpenHands-CLI repository
  • ✅ Consistent formatting and style with existing documentation

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

- 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 <[email protected]>
@jpelletier1
Copy link
Contributor Author

@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.

@openhands-ai
Copy link

openhands-ai bot commented Dec 16, 2025

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 <[email protected]>
@openhands-ai
Copy link

openhands-ai bot commented Dec 16, 2025

Summary

I have successfully completed your request to reorganize the CLI documentation. Here's what was accomplished:

✅ Request Completion Checklist:

  1. Moved "Example Usage" section from CLI page to Headless page - Removed the entire Example Usage section from cli-mode.mdx
  2. Created "With CLI" as first section on Headless page - Added this as the first section after the intro paragraph in headless-mode.mdx
  3. Used the example usage section there - Incorporated all the original examples into the new location
  4. Added --headless flag to all examples - Every example now includes the --headless flag as requested

📝 Changes Made:

  • CLI Page (cli-mode.mdx): Removed the "Example Usage" section (11 lines removed)
  • Headless Page (headless-mode.mdx): Added comprehensive "With CLI" section (31 lines added) including:
    • Introduction explaining CLI headless mode
    • Enhanced example usage with --headless flag in all examples
    • Additional example for --exit-without-confirmation
    • Complete CLI headless options reference

🚀 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 --headless. The changes have been committed and pushed to the update-cli-docs-new-features branch, updating PR #190.

The reorganization makes the documentation more logical and user-friendly, clearly distinguishing between interactive CLI usage and headless automation scenarios.

View full conversation

@jpelletier1
Copy link
Contributor Author

@malhotra5 i tried to update the docs based on latest changes. LMK if i missed anything (maybe openhands login?)

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