mirror of https://github.com/All-Hands-AI/OpenHands.git synced 2026-04-29 03:00:45 -04:00

Files

Xingyao Wang f80ecec772 [Arch] Add tests for EventStreamRuntime and fix bash parsing (#2933 )

* deprecating recall action

* fix integration tests

* fix integration tests

* refractor runtime to use async

* remove search memory

* rename .initialize to .ainit

* draft of runtime image building (separate from img agnostic)

* refractor runtime build into separate file and add unit tests for it

* fix image agnostic tests

* move `split_bash_commands` into a separate util file

* fix bash pexcept parsing for env

* refractor add_env_var from sandbox to runtime;
add test runtime for env var, remove it from sandbox;

* remove unclear comment

* capture broader error

* make `add_env_var` handle multiple export at the same time

* add multi env var test

* fix tests with new config

* make runtime tests a separate ci to avoid full disk

* Update Runtime README with architecture diagram and detailed explanations

* update test

* remove dependency of global config in sandbox test

* fix sandbox typo

* runtime tests does not need ghcr build now

* remove download runtime img

* remove dependency of global config in sandbox test

* fix sandbox typo

* try to free disk before running the tests

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* try to reduce code duplication

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* Update opendevin/runtime/client/README.md

Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

* cleanup before setup

* temporarily remove this enable lint test since env var are now handled by runtime

* linter

---------

Co-authored-by: OpenDevin <opendevin@all-hands.dev>
Co-authored-by: Yufan Song <33971064+yufansong@users.noreply.github.com>

2024-07-18 06:10:45 +08:00

auth

Remove global config from auth (#2962 )

2024-07-17 06:25:45 -04:00

data_models

Add links to a feedback sharing site (#2580 )

2024-06-22 09:36:31 +02:00

mock

Refactor session management (#1810 )

2024-05-22 18:33:16 +00:00

session

[Arch] Add tests for EventStreamRuntime and fix bash parsing (#2933 )

2024-07-18 06:10:45 +08:00

__init__.py

feat: websocket connection management and sandbox bound to session. (#559 )

2024-04-05 12:19:52 -05:00

listen.py

Fix bug with model list (#2978 )

2024-07-17 15:08:31 +00:00

README.md

arch: deprecating recall action and search_memory (#2900 )

2024-07-12 19:23:21 +00:00

README.md

OpenDevin Server

This is a WebSocket server that executes tasks using an agent.

Install

Follow the instructions in the base README.md to install dependencies and set up.

Start the Server

uvicorn opendevin.server.listen:app --reload --port 3000

Test the Server

You can use websocat to test the server.

websocat ws://127.0.0.1:3000/ws
{"action": "start", "args": {"task": "write a bash script that prints hello"}}

Supported Environment Variables

LLM_API_KEY=sk-... # Your OpenAI API Key
LLM_MODEL=gpt-4o   # Default model for the agent to use
WORKSPACE_BASE=/path/to/your/workspace # Default absolute path to workspace

API Schema

There are two types of messages that can be sent to, or received from, the server:

Actions
Observations

Actions

An action has three parts:

action: The action to be taken
args: The arguments for the action
message: A friendly message that can be put in the chat log

There are several kinds of actions. Their arguments are listed below. This list may grow over time.

initialize - initializes the agent. Only sent by client.
- model - the name of the model to use
- directory - the path to the workspace
- agent_cls - the class of the agent to use
start - starts a new development task. Only sent by the client.
- task - the task to start
read - reads the content of a file.
- path - the path of the file to read
write - writes the content to a file.
- path - the path of the file to write
- content - the content to write to the file
run - runs a command.
- command - the command to run
browse - opens a web page.
- url - the URL to open
think - Allows the agent to make a plan, set a goal, or record thoughts
- thought - the thought to record
finish - agent signals that the task is completed

Observations

An observation has four parts:

observation: The observation type
content: A string representing the observed data
extras: additional structured data
message: A friendly message that can be put in the chat log

There are several kinds of observations. Their extras are listed below. This list may grow over time.

read - the content of a file
- path - the path of the file read
browse - the HTML content of a url
- url - the URL opened
run - the output of a command
- command - the command run
- exit_code - the exit code of the command
chat - a message from the user