You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workshop/README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,8 @@ This guide will walk you through pulling the pre-built environment, launching th
7
7
## 📦 Repository Overview
8
8
9
9
In this repository, you will find:
10
-
-**Pre-prepared Cases**: Classic verification examples along with their historical offline verification records.
10
+
11
+
-**Pre-prepared Cases**: Classic verification examples along with their historical verification records.
11
12
-**Docker Scripts**: The `Dockerfile` and `start_demo.sh` scripts, which our CI uses to automatically build and publish the workshop image.
12
13
-**Environment Template**: A `.env.template` file for optional API configuration.
13
14
@@ -18,23 +19,30 @@ In this repository, you will find:
18
19
You **do not** need to build the Docker image yourself. The tutorial repository's CI has automatically built and published the image for you.
19
20
20
21
### 1. Pull the Docker Image
22
+
21
23
First, pull the latest workshop image to your local machine:
24
+
22
25
```bash
23
-
docker pull ghcr.io/xs-mlvp/ucagent:workshop_demo
26
+
docker pull ghcr.io/xs-mlvp/workshop:latest
24
27
```
25
28
26
29
### 2. Launch the Demo Environment
30
+
27
31
Start the container using the following command. This will spin up the Master API server and load the pre-configured background agents:
32
+
28
33
```bash
29
34
docker run -it --rm --network host ghcr.io/xs-mlvp/ucagent:workshop_demo
30
35
```
31
-
*(Note: We use `--network host` so the container can easily map to your local ports and share your host's network settings.)*
36
+
37
+
_(Note: We use `--network host` so the container can easily map to your local ports and share your host's network settings.)_
32
38
33
39
### 3. Explore the Web UI
40
+
34
41
Once the terminal indicates that all services have started, open your web browser and navigate to:
35
42
👉 **http://localhost:8800**
36
43
37
44
In this unified Master Web Interface, you can:
45
+
38
46
-**View Pre-loaded Tasks**: On the left-hand task panel, you will see the cases. Both should have a green **Online** status indicator.
39
47
-**Review History**: Click the **API** connection button next to any task to jump into its real-time control center. Here, you can review previously generated code, stage verification logs, and Diff files without needing any LLM API keys.
40
48
@@ -46,6 +54,7 @@ The quick start above is perfect for exploring the UI and viewing the pre-genera
46
54
47
55
1.**Prepare your `.env` file**
48
56
Copy the provided template and fill in your API credentials (e.g., OpenAI or a compatible interface):
57
+
49
58
```bash
50
59
cp .env.template .env
51
60
# Edit .env to add your OPENAI_API_KEY, OPENAI_API_BASE, and OPENAI_MODEL
@@ -54,7 +63,7 @@ The quick start above is perfect for exploring the UI and viewing the pre-genera
54
63
2.**Launch with API Access**
55
64
Run the container again, this time attaching your `.env` file so the agents can connect to the LLM:
56
65
```bash
57
-
docker run -it --rm --network host --env-file .env ghcr.io/xs-mlvp/ucagent:workshop_demo
66
+
docker run -it --rm --network host --env-file .env ghcr.io/xs-mlvp/workshop:latest
58
67
```
59
-
68
+
60
69
With your API keys successfully loaded, the Agents are now fully empowered to execute new automated verification workflows based on your commands!
0 commit comments