From a9cf7e6ee6b1c9d664cd71623dc6e95b4a726ffb Mon Sep 17 00:00:00 2001 From: mamoodi Date: Fri, 6 Sep 2024 15:52:11 -0400 Subject: [PATCH] docs: fix cli and headless commands (#3768) --- README.md | 4 ++-- docs/modules/usage/getting-started.md | 2 +- docs/modules/usage/how-to/cli-mode.md | 8 ++++---- docs/modules/usage/how-to/custom-sandbox-guide.md | 2 +- docs/modules/usage/how-to/headless-mode.md | 6 +++--- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 71df2601af91..1186b89cd6db 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/modules/usage/getting-started.md b/docs/modules/usage/getting-started.md index effc5391cc5b..81517bec7f65 100644 --- a/docs/modules/usage/getting-started.md +++ b/docs/modules/usage/getting-started.md @@ -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 \ diff --git a/docs/modules/usage/how-to/cli-mode.md b/docs/modules/usage/how-to/cli-mode.md index 946ba265168e..c619560af523 100644 --- a/docs/modules/usage/how-to/cli-mode.md +++ b/docs/modules/usage/how-to/cli-mode.md @@ -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. diff --git a/docs/modules/usage/how-to/custom-sandbox-guide.md b/docs/modules/usage/how-to/custom-sandbox-guide.md index c2bec40b28a2..fa16fadcbc2f 100644 --- a/docs/modules/usage/how-to/custom-sandbox-guide.md +++ b/docs/modules/usage/how-to/custom-sandbox-guide.md @@ -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! diff --git a/docs/modules/usage/how-to/headless-mode.md b/docs/modules/usage/how-to/headless-mode.md index 46b557b17382..ea620c65ee6a 100644 --- a/docs/modules/usage/how-to/headless-mode.md +++ b/docs/modules/usage/how-to/headless-mode.md @@ -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" ```