Skip to main content

OpenHands CLI - Terminal User Interface for OpenHands AI Agent

Project description

Logo

OpenHands V1 CLI

(Powered by OpenHands Software Agent SDK)

Run OpenHands agent inside your terminal, favorite IDE, CI pipelines, local browser, or secure OpenHands Cloud sandboxes.

Installation

Using uv (Recommended)

Requires Python 3.12+ and uv.

uv tool install openhands --python 3.12

Executable Binary

Install the standalone binary with the install script:

curl -fsSL https://install.openhands.dev/install.sh | sh

Usage

Quick Start

The first time you run the CLI, it will guide you through configuring your LLM settings:

openhands

Configuration

OpenHands CLI stores configuration under ~/.openhands/ (created on first run):

  • agent_settings.json: persisted agent settings (including condenser config)
  • cli_config.json: CLI/TUI preferences (e.g., critic enabled)
  • mcp.json: MCP server configuration

By default, environment variables like LLM_API_KEY, LLM_MODEL, and LLM_BASE_URL are ignored; pass --override-with-envs to apply them (not persisted).

Running Modes

Mode Command Best For
Terminal (TUI) openhands Interactive development
IDE Integration openhands acp IDEs (Toad, Zed, VSCode, JetBrains, etc)
Headless openhands --headless -t "task" CI, scripts, and automation
Web Interface openhands web Browser-based TUI
GUI Server openhands serve Full web GUI

Features

MCP Servers

Extend OpenHands capabilities with Model Context Protocol (MCP) servers:

# List configured servers
openhands mcp list

# Add a server
openhands mcp add tavily --transport stdio \
  npx -- -y mcp-remote "https://mcp.tavily.com/mcp/?tavilyApiKey=<your-api-key>"

# Enable/disable servers
openhands mcp enable <server-name>
openhands mcp disable <server-name>

Confirmation Modes

Control how the agent handles actions:

# Default: ask for confirmation on each action
openhands

# Auto-approve all actions
openhands --always-approve  # or --yolo

# LLM-based security analyzer
openhands --llm-approve

Cloud Conversations

Run tasks on OpenHands Cloud. First, authenticate with OpenHands Cloud to fetch your settings:

# Login to OpenHands Cloud
openhands login

# Run a task on OpenHands Cloud
openhands cloud -t "Fix the login bug"

Headless Mode

Run OpenHands without the interactive UI for CI/CD pipelines and automation:

openhands --headless -t "Write unit tests for auth.py"
openhands --headless -f instructions.md  # or use a file

# With JSON output for parsing
openhands --headless --json -t "Create a Flask app"

Resume Conversations

openhands --resume              # list recent conversations
openhands --resume <id>         # resume specific conversation
openhands --resume --last       # resume most recent

Documentation

For complete documentation, visit https://docs.openhands.dev/openhands/usage/cli.

License

MIT License - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openhands-1.12.1.tar.gz (650.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openhands-1.12.1-py3-none-any.whl (198.6 kB view details)

Uploaded Python 3

File details

Details for the file openhands-1.12.1.tar.gz.

File metadata

  • Download URL: openhands-1.12.1.tar.gz
  • Upload date:
  • Size: 650.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for openhands-1.12.1.tar.gz
Algorithm Hash digest
SHA256 4adb9470ae9c986c1818c3e394e0112e69fae397688374a533c8c332603b157e
MD5 a2a9ee8541fb0e848fefc225036ec2f7
BLAKE2b-256 c3733f47bc06918a8f0b3964fed952354540de70180a90e516f4dc42cb4d000f

See more details on using hashes here.

File details

Details for the file openhands-1.12.1-py3-none-any.whl.

File metadata

  • Download URL: openhands-1.12.1-py3-none-any.whl
  • Upload date:
  • Size: 198.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for openhands-1.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8848f758d35a1f9195a363479b79f5525052f184b4645d8d2aeeebfda4d5b24
MD5 815fced12e5a57b2746741bb5e86deb0
BLAKE2b-256 0601e88bcf05d19e2f88d116df504b4c864a2ff0b9195593cbe45cc50fcc6dd0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page