docs: fix cli and headless commands (#3768)

This commit is contained in:
mamoodi
2024-09-06 15:52:11 -04:00
committed by GitHub
parent 8392a3fb6b
commit a9cf7e6ee6
5 changed files with 11 additions and 11 deletions

View File

@@ -40,7 +40,7 @@ See the [Getting Started](https://docs.all-hands.dev/modules/usage/getting-start
system requirements and more information.
```bash
WORKSPACE_BASE=$(pwd)/workspace
export WORKSPACE_BASE=$(pwd)/workspace
docker run -it --pull=always \
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.9.2-nikolaik \
@@ -70,7 +70,7 @@ Having issues? The [Troubleshooting Guide](https://docs.all-hands.dev/modules/us
To learn more about the project, and for tips on using OpenHands,
**check out our [documentation](https://docs.all-hands.dev/modules/usage/getting-started)**.
There you'll find resources on how to use different LLM providers (like ollama and Anthropic's Claude),
There you'll find resources on how to use different LLM providers,
troubleshooting resources, and advanced configuration options.
## 🤝 How to Contribute

View File

@@ -16,7 +16,7 @@ The easiest way to run OpenHands is in Docker. You can change `WORKSPACE_BASE` b
existing code that you'd like to modify.
```bash
WORKSPACE_BASE=$(pwd)/workspace
export WORKSPACE_BASE=$(pwd)/workspace
docker run -it --pull=always \
-e SANDBOX_RUNTIME_CONTAINER_IMAGE=ghcr.io/all-hands-ai/runtime:0.9.2-nikolaik \

View File

@@ -8,7 +8,7 @@ This mode is different from the [headless mode](headless-mode), which is non-int
To start an interactive OpenHands session via the command line, follow these steps:
1. Ensure you have followed the [Development setup instructions](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md).
1. Ensure you have followed the [Development setup instructions](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)
2. Run the following command:
@@ -35,10 +35,10 @@ WORKSPACE_BASE=$(pwd)/workspace
2. Set `LLM_MODEL` to the model you want to use:
```bash
LLM_MODEL="claude-3-5-sonnet-20240620"
LLM_MODEL="anthropic/claude-3-5-sonnet-20240620"
```
3. Set `LLM_API_KEY` to an API key, e.g., for OpenAI or Anthropic:
3. Set `LLM_API_KEY` to your API key:
```bash
LLM_API_KEY="abcde"
@@ -58,7 +58,7 @@ docker run -it \
--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
python -m openhands.core.cli
```
This command will start an interactive session in Docker where you can input tasks and receive responses from OpenHands.

View File

@@ -72,7 +72,7 @@ Run OpenHands by running ```make run``` in the top level directory.
Navigate to ```localhost:3001``` and check if your desired dependencies are available.
In the case of the example above, running ```node -v``` in the terminal produces ```v20.15.0```
In the case of the example above, running ```node -v``` in the terminal produces ```v20.15.0```.
Congratulations!

View File

@@ -29,10 +29,10 @@ WORKSPACE_BASE=$(pwd)/workspace
2. Set `LLM_MODEL` to the model you want to use:
```bash
LLM_MODEL="claude-3-5-sonnet-20240620"
LLM_MODEL="anthropic/claude-3-5-sonnet-20240620"
```
3. Set `LLM_API_KEY` to an API key, e.g., for OpenAI or Anthropic:
3. Set `LLM_API_KEY` to your API key:
```bash
LLM_API_KEY="abcde"
@@ -52,5 +52,5 @@ docker run -it \
--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.main -t "write a bash script that prints hi"
python -m openhands.core.main -t "write a bash script that prints hi"
```