Skip to content

Commit 2896019

Browse files
authored
Update README.md
1 parent 91f4077 commit 2896019

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ A TypeScript client library for the OpenHands Agent Server API that mirrors the
2323

2424
## Quick Start
2525

26+
### Start an AgentServer
27+
You'll need an AgentServer running somewhere for the client to connect to. You can run one in docker:
28+
```bash
29+
docker run -p 8000:8000 -p 8001:8001 \
30+
-e OH_ENABLE_VNC=false \
31+
-e SESSION_API_KEY="$SESSION_API_KEY" \
32+
-e OH_ALLOW_CORS_ORIGINS='["*"]' \
33+
ghcr.io/all-hands-ai/agent-server:78938ee-python
34+
```
35+
2636
### Creating a Conversation
2737

2838
```typescript
@@ -286,14 +296,3 @@ MIT
286296
## Contributing
287297

288298
Contributions are welcome! Please feel free to submit a Pull Request.
289-
290-
## Development
291-
```
292-
docker run -p 8000:8000 -p 8001:8001 \
293-
-e OH_ENABLE_VNC=false \
294-
-e SESSION_API_KEY="$SESSION_API_KEY" \
295-
-e OH_ALLOW_CORS_ORIGINS='["*"]' \
296-
ghcr.io/all-hands-ai/agent-server:78938ee-python
297-
```
298-
299-
Then start the app

0 commit comments

Comments
 (0)