mirror of
https://github.com/All-Hands-AI/OpenHands.git
synced 2026-01-09 14:57:59 -05:00
doc updates for headless / cli mode (#3707)
* Documentation update for headless / cli mode * WIP * WIP * WIP * Fix link
This commit is contained in:
@@ -1,18 +1,31 @@
|
||||
# Running in Headless Mode
|
||||
# Running in Headless / CLI Mode
|
||||
|
||||
You can run OpenHands via a CLI, without starting the web application. This makes it easy
|
||||
to automate tasks with OpenHands.
|
||||
to automate tasks with OpenHands. There are 2 main modes of operation:
|
||||
|
||||
* **Headless** : Designed for use with scripts
|
||||
* **CLI** : Designed for interactive use via a console
|
||||
|
||||
As with other modes, the environment is configurable via environment variables or by saving values into [config.toml](https://github.com/All-Hands-AI/OpenHands/blob/main/config.template.toml)
|
||||
|
||||
## With Python
|
||||
To run OpenHands in headless mode with Python,
|
||||
[follow the Development setup instructions](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md),
|
||||
and then run:
|
||||
|
||||
### Headless with Python
|
||||
```bash
|
||||
poetry run python -m openhands.core.main -t "write a bash script that prints hi"
|
||||
```
|
||||
|
||||
## With Docker
|
||||
### CLI with Python
|
||||
```bash
|
||||
poetry run python -m openhands.core.cli
|
||||
|
||||
How can I help? >> write a bash script that prints hi
|
||||
```
|
||||
|
||||
## Headless With Docker
|
||||
To run OpenHands in headless mode with Docker, run:
|
||||
|
||||
```bash
|
||||
@@ -35,7 +48,34 @@ docker run -it \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
ghcr.io/all-hands-ai/openhands:main \ # TODO: pin a version here
|
||||
python -m openhands.core.main \
|
||||
ghcr.io/all-hands-ai/openhands:0.9 \
|
||||
poetry run python -m openhands.core.main \
|
||||
-t "Write a bash script that prints Hello World"
|
||||
```
|
||||
|
||||
## CLI With Docker
|
||||
To run OpenHands in cli mode with Docker, run:
|
||||
|
||||
```bash
|
||||
# Set WORKSPACE_BASE to the directory you want OpenHands to edit
|
||||
WORKSPACE_BASE=$(pwd)/workspace
|
||||
|
||||
# Set LLM_API_KEY to an API key, e.g. for OpenAI or Anthropic
|
||||
LLM_API_KEY="abcde"
|
||||
|
||||
# Set LLM_MODEL to the model you want to use
|
||||
LLM_MODEL="gpt-4o"
|
||||
|
||||
docker run -it \
|
||||
--pull=always \
|
||||
-e SANDBOX_USER_ID=$(id -u) \
|
||||
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
|
||||
-e LLM_API_KEY=$LLM_API_KEY \
|
||||
-e LLM_MODEL=$LLM_MODEL \
|
||||
-v $WORKSPACE_BASE:/opt/workspace_base \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
--add-host host.docker.internal:host-gateway \
|
||||
--name openhands-app-$(date +%Y%m%d%H%M%S) \
|
||||
ghcr.io/all-hands-ai/openhands:0.9 \
|
||||
poetry run python -m openhands.core.cli
|
||||
```
|
||||
Reference in New Issue
Block a user