Skip to content

docs: align sandbox quickstart defaults #1439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
koriyoshi2041 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: align sandbox quickstart defaults #1439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ agent-canvas --backend-only # agent server + automation backend + ingress only
**macOS / Linux:**

```sh
export PROJECTS_PATH="$HOME/projects" # directory containing your project folders
export PROJECTS_PATH="$HOME/Projects" # directory containing your project folders
mkdir -p "$PROJECTS_PATH" "$HOME/.openhands"

docker run -it --rm \
-p 8000:8000 \
-v "$HOME/.openhands:/home/openhands/.openhands" \
-v "${PROJECTS_PATH}:/projects" \
ghcr.io/openhands/agent-canvas:1.0.0-rc.11
ghcr.io/openhands/agent-canvas:latest
```

**Windows (PowerShell / Windows Terminal):** See [README.windows.md](./README.windows.md) for the equivalent commands.
Expand Down
6 changes: 3 additions & 3 deletions README.windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ For the main install options and overall context, see [README.md](./README.md).
- A host directory for `PROJECTS_PATH` containing the project folders you want the agent to access (create it before starting the container)

```powershell
docker pull ghcr.io/openhands/agent-canvas:1.0.0-rc.11
docker pull ghcr.io/openhands/agent-canvas:latest

$env:PROJECTS_PATH = Join-Path $HOME "projects" # directory containing your project folders
$env:PROJECTS_PATH = Join-Path $HOME "Projects" # directory containing your project folders
New-Item -ItemType Directory -Force -Path $env:PROJECTS_PATH, (Join-Path $env:USERPROFILE ".openhands") | Out-Null

docker run -it --rm `
-p 8000:8000 `
-v "$($env:USERPROFILE)\.openhands:/home/openhands/.openhands" `
-v "$($env:PROJECTS_PATH):/projects" `
ghcr.io/openhands/agent-canvas:1.0.0-rc.11
ghcr.io/openhands/agent-canvas:latest
```

The agent will be able to access any project under `PROJECTS_PATH`.
Loading