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

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

# 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"

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

Documentation

For complete documentation, visit 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.11.0.tar.gz (432.2 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.11.0-py3-none-any.whl (179.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openhands-1.11.0.tar.gz
  • Upload date:
  • Size: 432.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.11.0.tar.gz
Algorithm Hash digest
SHA256 3dec7636a4c5e0b722a14c068c003d48d9cded314c4495845b9323e6be631686
MD5 dcfee11e70d5fb42fe0b1137c1d4b2cb
BLAKE2b-256 ad83b1a5c5aed3937a773ff8438d770747c0292e6de2659abac95d049164fc22

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openhands-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 179.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afe82d170d7856bd647c7822b3c088c9b8bca66369da5c2557fb67263ecbe212
MD5 22779aad6698650be632290184ffcd2a
BLAKE2b-256 0563508770924bd4c0e2aafbdaff7a8d7daca51f1e8986c4f6c95b75499e8595

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