From 0148c9ef4b54adb43e81536c24554af6341f2bfa Mon Sep 17 00:00:00 2001
From: zhun <zhun.wang@berkeley.edu>
Date: Mon, 2 Jun 2025 20:37:36 -0700
Subject: [PATCH] add examples

---
 .gitmodules     |  3 +++
 README.md       | 15 ++++++++-------
 examples/agents |  1 +
 3 files changed, 12 insertions(+), 7 deletions(-)
 create mode 100644 .gitmodules
 create mode 160000 examples/agents

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..74fb98b
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "examples/agents"]
+	path = examples/agents
+	url = https://github.com/sunblaze-ucb/cybergym-agent-examples.git
diff --git a/README.md b/README.md
index b8c1d4a..b3978bf 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,6 @@ git lfs install
 git clone https://huggingface.co/datasets/sunblaze-ucb/cybergym cybergym_data
 ```
 
-### Agents
-For different agents, please follow the instructions in the separate folders
-- [Cybench](scripts/agents/cybench/README.md)
-- [ENiGMA](scripts/agents/enigma/README.md)
-- [Codex](scripts/agents/codex/README.md)
-- [OpenHands](scripts/agents/openhands/README.md)
 
 ### Download Server Data
 Download the PoC submission server data
@@ -104,4 +98,11 @@ python3 scripts/verify_agent_result.py \
 
 # example output
 # {'agent_id': '8113f33401d34ee3ae48cf823b757ac7', 'task_id': 'arvo:3848', 'poc_id': '8f20a76a34d0482a82da247f96b39f01', 'poc_hash': '714f093fe3c90135c2845fa8bbc7dfa429051e7f91d8ce398b3cd011cea15f59', 'poc_length': 662, 'vul_exit_code': 0, 'fix_exit_code': 0, 'created_at': datetime.datetime(2025, 5, 15, 23, 39, 48, 449451), 'updated_at': datetime.datetime(2025, 5, 15, 23, 39, 49, 435333)}
-```
\ No newline at end of file
+```
+
+### Example Agents
+The four example agents can be installed as:
+```bash
+git submodule update --init --recursive
+```
+Then check the instructions in separate folder: [Example Agents](examples/agents/README.md)
\ No newline at end of file
diff --git a/examples/agents b/examples/agents
new file mode 160000
index 0000000..58b9c6a
--- /dev/null
+++ b/examples/agents
@@ -0,0 +1 @@
+Subproject commit 58b9c6a88d1ad3768d71bf68c8e95021596feec9