Skip to content

Commit d5d2c5e

Browse files
committed
[Dev] add .env Readme instruction and modify titles
1 parent 58a4155 commit d5d2c5e

File tree

3 files changed

+18
-57
lines changed

3 files changed

+18
-57
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<br>
99
<div align="center" style="line-height: 1;">
1010
<a href="https://www.otatech.ai/"><img alt="Homepage"
11-
src="https://img.shields.io/badge/Home-Page-blue"/></a>
11+
src="https://img.shields.io/badge/Visit-otatech.ai-blue"/></a>
1212
<a href="https://huggingface.co/OTA-AI/OTA-v1"><img alt="Hugging Face"
1313
src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-OTA%20AI-ffc107?color=ffc107&logoColor=white"/></a>
1414
<a href="https://github.com/OTA-Tech-AI/webagentprotocol/blob/main/LICENSE"><img alt="Code License"
@@ -71,15 +71,27 @@ set PYTHONPATH=C:/path/to/webagentprotocol # for Windows
7171
export PYTHONPATH=/path/to/webagentprotocol # for Linux
7272
```
7373

74+
Create **.env** file under the repo root directory with your own API keys:
75+
```
76+
OPENAI_API_KEY=sk-proj-...
77+
DEEPSEEK_API_KEY=sk-...
78+
```
79+
80+
## Record
81+
82+
### WAP record extension
83+
Please refer to [OTA‑WAP Chrome Extension](https://github.com/OTA-Tech-AI/webagentprotocol/tree/main/chrome-extension) to setup action capturer in your Chrome browser.
7484

75-
## Start data‑collection server
85+
### Start data‑collection server
7686

7787
Run the following command to start the server to collect data from the extension:
7888
```bash
7989
python action_collect_server.py
8090
```
91+
**Once the server is up, you can start to record from the page using WAP Chrome extension.**
8192

82-
The server listens on http://localhost:4934/action-data and saves each session to:
93+
The server listens on http://localhost:4934/action-data by default, please make sure the Host and Port in the extension settings match this server config.
94+
Each session will be saved to:
8395

8496
```bash
8597
data/YYYYMMDD/taskid/summary_event_<timestamp>.json
@@ -124,7 +136,7 @@ data_processed/exact_replay/
124136
└─ wap_smart_replay_list_<task_id>.json # final exact replay list for the agent
125137
```
126138

127-
## Run the agent
139+
## Replay
128140
```bash
129141
python run_replay.py --model-provider openai --wap_replay_list data_processed/exact_replay/wap_exact_replay_list_<task_id>.json --max-concurrent 1
130142
```

browser_use/README.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

chrome-extension/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<br>
99
<div align="center" style="line-height: 1;">
1010
<a href="https://www.otatech.ai/"><img alt="Homepage"
11-
src="https://img.shields.io/badge/Home-Page-blue"/></a>
11+
src="https://img.shields.io/badge/Visit-otatech.ai-blue"/></a>
1212
<a href="https://huggingface.co/OTA-AI/OTA-v1"><img alt="Hugging Face"
1313
src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-OTA%20AI-ffc107?color=ffc107&logoColor=white"/></a>
1414
<a href="https://github.com/OTA-Tech-AI/webagentprotocol/tree/main/chrome-extension/LICENSE"><img alt="Code License"
@@ -29,7 +29,7 @@ WAP (Web Agent protocol) is our standard protocol for AI Agent record-and-play i
2929
Installation
3030
-----
3131

32-
Install our public Chrome extension at [WAP Browser Action Capturer](https://chromewebstore.google.com/detail/wap-browser-action-captur/chikiefojkdpmijbhepipdkadcljlbmh).
32+
Install our public **Chrome extension** at [WAP Browser Action Capturer](https://chromewebstore.google.com/detail/wap-browser-action-captur/chikiefojkdpmijbhepipdkadcljlbmh).
3333

3434
If you want to install this extension locally, please refer to: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world
3535

0 commit comments

Comments
 (0)