Skip to content

Commit

Permalink
docs: fix cli and headless commands (All-Hands-AI#3768)
Browse files Browse the repository at this point in the history
  • Loading branch information
mamoodi authored Sep 6, 2024
1 parent 8392a3f commit a9cf7e6
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/usage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/usage/how-to/cli-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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"
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/usage/how-to/custom-sandbox-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/usage/how-to/headless-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
```

0 comments on commit a9cf7e6

Please sign in to comment.