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

Files

Xingyao Wang bd68249fba [Arch] Test EventStreamRuntime to ensure its feature parity with ServerRuntime (#3157 )

* Remove global config from memory

* Remove runtime global config

* Remove from storage

* Remove global config

* Fix event stream tests

* Fix sandbox issue

* Change config

* Removed transferred tests

* Add swe env box

* Fixes on testing

* Fixed some tests

* Merge with stashed changes

* Fix typing

* Fix ipython test

* Revive function

* Make temp_dir fixture

* Remove test to avoid circular import

* fix eventstream filestore for test_runtime

* fix parse arg issue that cause integration test to fail

* support swebench pull from custom namespace

* add back simple tests for runtime

* move multi-line bash tests to test_runtime;
support multi-line bash for esruntime;

* add testcase to handle PS2 prompt

* use bashlex for bash parsing to handle multi-line commands;
add testcases for multi-line commands

* revert ghcr runtime change

* Apply stash

* fix run as other user;
make test async;

* fix test runtime for run as od

* add run-as-devin to all the runtime tests

* handle the case when username is root

* move all run-as-devin tests from sandbox;
only tests a few cases on different user to save time;

* move over multi-line echo related tests to test_runtime

* fix user-specific jupyter by fixing the pypoetry virtualenv folder

* make plugin's init async;
chdir at initialization of jupyter plugin;
move ipy simple testcase to test runtime;

* support agentskills import in
move tests for jupyter pwd tests;
overload `add_env_vars` for EventStreamRuntime to update env var also in Jupyter;
make agentskills read env var lazily, in case env var is updated;

* fix ServerRuntime agentskills issue

* move agnostic image test to test_runtime

* merge runtime tests in CI

* fix enable auto lint as env var

* update warning message

* update warning message

* test for different container images

* change parsing output as debug

* add exception handling for update_pwd_decorator

* fix unit test indentation

* add plugins as default input to Runtime class;
remove init_sandbox_plugins;
implement add_env_var (include jupyter) in the base class;

* fix server runtime auto lint

* Revert "add exception handling for update_pwd_decorator"

This reverts commit 2b668b1506.

* tries to print debugging info for agentskills

* explictly setting uid (try fix permission issue)

* Revert "tries to print debugging info for agentskills"

This reverts commit 8be4c86756.

* set sandbox user id during testing to hopefully fix the permission issue

* add browser tools for server runtime

* try to debug for old pwd

* update debug cmd

* only test agnostic runtime when TEST_RUNTIME is Server

* fix temp dir mkdir

* load TEST_RUNTIME at the beginning

* remove ipython tests

* only log to file when DEBUG

* default logging to project root

* temporarily remove log to file

* fix LLM logger dir

* fix logger

* make set pwd an optional aux action

* fix prev pwd

* fix infinity recursion

* simplify

* do not import the whole od library to avoid logger folder by jupyter

* fix browsing

* increase timeout

* attempt to fix agentskills yet again

* clean up in testcases, since CI maybe run as non-root

* add _cause attribute for event.id

* remove parent

* add a bunch of debugging statement again for CI :(

* fix temp_dir fixture

* change all temp dir to follow pytest's tmp_path_factory

* remove extra bracket

* clean up error printing a bit

* jupyter chdir to self.config.workspace_mount_path_in_sandbox on initialization

* jupyter chdir to self.config.workspace_mount_path_in_sandbox on initialization

* add typing for tmp dir fixture

* clear the directory before running the test to avoid weird CI temp dir

* remove agnostic test case for server runtime

* Revert "remove agnostic test case for server runtime"

This reverts commit 30e2181c3f.

* disable agnostic tests in CI

* fix test

---------

Co-authored-by: Graham Neubig <neubig@gmail.com>

2024-07-31 04:30:59 +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

Remove monologue agent (#3036 )

2024-07-19 19:25:05 +00:00

session

[Arch] Test EventStreamRuntime to ensure its feature parity with ServerRuntime (#3157 )

2024-07-31 04:30:59 +08:00

__init__.py

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

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

listen.py

Remove remaining global config (#3099 )

2024-07-26 18:43:32 +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