lingshu-examples · 灵枢示例库

Copy-paste-runnable Examples

从 30 行 Hello 到完整多 Agent 系统 · 全部 Maven module,可单 module 运行

---

这是什么

lingshu-examples 是 可直接 copy-paste-runnable 的示例集合。每个示例都是一个独立 Maven module:

git clone https://github.com/lingshu-ai-agent/lingshu-examples.git
cd lingshu-examples
mvn -pl demo-fibonacci -am exec:java -Dexec.mainClass=...DemoFibonacciApp

就能跑。

---

📚 示例清单(按难度递增)

Level 1 · Hello 入门

模块	主题	代码量
demo-fibonacci	单 LLM 调用生成代码	~30 行
demo-translate	多语言翻译 ReAct	~50 行
demo-qa-bot	知识库问答	~80 行

Level 2 · Tool & Skill

模块	主题	代码量
tool-database	SQL Tool + JDBC 数据源	~100 行
skill-shell-exec	Skill = bash 工具	~120 行
tool-http-api	自定义 REST Tool	~90 行

Level 3 · SPI 替换

模块	主题	代码量
provider-openai	接入 OpenAI LlmProvider	~50 行
flowengine-dag	自定义 DAG FlowEngine	~200 行
sandbox-chroot	chroot RuntimeSandbox	~150 行

Level 4 · 多 Agent / 复杂

模块	主题	代码量
multi-agent-researcher	Researcher + Writer 两 Agent 协同	~300 行
multi-agent-coder	Planner / Coder / Tester 三 Agent	~400 行
production-incident-bot	真实告警 → 多 Agent 应急响应	~500 行

---

🚀 跑起来

前置

• JDK 17+(compile target JDK 8 syntax — no sealed/records/var/List.of)
• Maven 3.6+
• 一个 LLM API key(ANTHROPIC_API_KEY 或 OPENAI_API_KEY)

单示例

mvn -pl demo-fibonacci -am exec:java \
    -Dexec.mainClass=ai.lingshu.examples.fibonacci.DemoFibonacciApp \
    -Dexec.env="ANTHROPIC_API_KEY=sk-ant-..."

全部跑一遍

./run-all.sh

---

📁 每个示例的标准结构

demo-fibonacci/
├── pom.xml
├── README.md                            ← 单独讲这个示例
└── src/main/java/ai/lingshu/examples/fibonacci/
    ├── DemoFibonacciApp.java            ← @SpringBootApplication
    ├── FibonacciAgentConfig.java        ← AgentConfig + YAML binding
    └── skill/
        └── SKILL.md                     ← 配套 Skill

每个示例的 README 写清:

• 🎯 目标
• 🧩 用到的 SPI slot
• ⚙️ 配置文件怎么写
• 📤 预期输出

---

🤝 贡献示例

欢迎 PR 新示例。要求:

• 独立 Maven module
• README 写清目标 / SPI / 输出
• 默认 demo 不消耗大额 token(每跑一次 < $0.05)
• 不带任何写死 API key

新示例模板:

lingshu skill new demo-my-thing
# 然后在 src/main/java/.../demo_my_thing/ 写代码

---

📚 相关

• 核心引擎:lingshu-ai-agent/lingshu
• CLI:lingshu-ai-agent/lingshu-cli
• Skill 市场:lingshu-ai-agent/lingshu-skill-market
• 文档:lingshu-ai-agent/lingshu-docs

---

📜 License

Apache 2.0 — see LICENSE.