Skip to content

Commit 03e18e8

Browse files
clxstartyuluo-yx
andauthored
docs: unify example startup commands with Maven Wrapper (mvnw) (#4728)
Co-authored-by: shown <yuluo08290126@gmail.com>
1 parent ff03b55 commit 03e18e8

5 files changed

Lines changed: 13 additions & 7 deletions

File tree

  • examples
    • deepresearch
    • documentation/src/main/java/com/alibaba/cloud/ai/examples/documentation/framework/advanced/a2a
    • multiagent-patterns/workflow

examples/deepresearch/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ export JINA_API_KEY=your_jina_api_key # Optional
1717

1818
### Run the Agent
1919

20-
1. **Run with Maven**
20+
1. **Run with Maven Wrapper** (run from the repository root; Maven installation is optional when using `mvnw`)
2121
```bash
22-
mvn spring-boot:run
22+
./mvnw -f examples/deepresearch spring-boot:run
2323
```
2424

2525
2. **Run in IDE**

examples/documentation/src/main/java/com/alibaba/cloud/ai/examples/documentation/framework/advanced/a2a/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ docker run --name nacos -d -p 8848:8848 -e MODE=standalone nacos/nacos-server:la
7878
### 2) 启动应用
7979

8080
```bash
81-
mvn -q -pl examples/documentation -am spring-boot:run
81+
./mvnw -q -f examples/documentation spring-boot:run
8282
```
8383

8484
### 3) 访问演示接口

examples/multiagent-patterns/workflow/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ Flow: **Question → Agent (list_tables → get_schema → run_query) → Answer
3030

3131
## Run
3232

33+
From the repository root (Maven installation is optional when using `mvnw`):
34+
3335
```bash
3436
# RAG agent
35-
mvn spring-boot:run -Dspring-boot.run.arguments="--workflow.rag.enabled=true --workflow.runner.enabled=true"
37+
./mvnw -f examples/multiagent-patterns/workflow spring-boot:run -Dspring-boot.run.arguments="--workflow.rag.enabled=true --workflow.runner.enabled=true"
3638

3739
# SQL agent
38-
mvn spring-boot:run -Dspring-boot.run.arguments="--workflow.sql.enabled=true --workflow.runner.enabled=true"
40+
./mvnw -f examples/multiagent-patterns/workflow spring-boot:run -Dspring-boot.run.arguments="--workflow.sql.enabled=true --workflow.runner.enabled=true"
3941
```
4042

4143
Set `AI_DASHSCOPE_API_KEY` environment variable.

examples/multiagent-patterns/workflow/src/main/java/com/alibaba/cloud/ai/examples/multiagents/workflow/ragagent/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ workflow.runner.enabled: true # optional demo on startup
2222
2323
## Run
2424
25+
From the repository root (Maven installation is optional when using `mvnw`):
26+
2527
```bash
26-
mvn spring-boot:run -Dspring-boot.run.arguments="--workflow.rag.enabled=true --workflow.runner.enabled=true"
28+
./mvnw -f examples/multiagent-patterns/workflow spring-boot:run -Dspring-boot.run.arguments="--workflow.rag.enabled=true --workflow.runner.enabled=true"
2729
```

examples/multiagent-patterns/workflow/src/main/java/com/alibaba/cloud/ai/examples/multiagents/workflow/sqlagent/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Uses H2 in-memory with a Chinook-like schema. Schema is initialized from `schema
2626

2727
## Run
2828

29+
From the repository root (Maven installation is optional when using `mvnw`):
30+
2931
```bash
30-
mvn spring-boot:run -Dspring-boot.run.arguments="--workflow.sql.enabled=true --workflow.runner.enabled=true"
32+
./mvnw -f examples/multiagent-patterns/workflow spring-boot:run -Dspring-boot.run.arguments="--workflow.sql.enabled=true --workflow.runner.enabled=true"
3133
```

0 commit comments

Comments
 (0)