项目简介
KunClaw 是一套面向生产的 Python Agent 框架:把大模型、记忆、工具注册与多轮 Function Calling、任务规划(可选 ReAct)收拢成可复用的包,并提供 CLI(会话、配置、健康检查)、示例智能体,以及可选的 Windows GUI / EXE 打包。
源码见 GitHub — KunClaw
PyPI / 安装名:kunclaw;导入包目录为src/agent_framework/。
项目结构(摘要)
KunClaw/
├── pyproject.toml / requirements.txt / .env.example
├── examples/customer_service.py # 多轮智能体演示
├── scripts/ # GUI 启动、build_exe
└── src/agent_framework/
├── cli.py # agentfw 入口
├── core/ # BaseAgent、ReAct、TaskPlanner
├── memory/ # 短期 / 长期 / HybridMemory
├── tools/ # ToolRegistry、@tool
├── gui/ · harness/ · evaluators/
| 区域 | 作用 |
|---|---|
core |
BaseAgent 主循环;ReActAgent;TaskPlanner 拆任务 |
memory |
HybridMemory;长期默认可向量检索,短期可选 Redis |
tools |
与 OpenAI tools 对齐的 JSON Schema |
harness |
.agent.json、会话目录、与 CLI 联动 |
evaluators |
token / 耗时等轻量统计扩展点 |
安装与快速运行
pip install -e .
# 或开发依赖:pip install -e ".[dev]"
python -m agent_framework doctor
python -m agent_framework prompt "用一句话介绍你自己" --session demo
python -m agent_framework chat --session demo
安装后提供命令 agentfw(Windows 用户级 Scripts 若不在 PATH,请用 python -m agent_framework ... 或仓库内 agentfw.cmd)。
配置
推荐项目根 .env(可复制 .env.example):
OPENAI_API_KEY=sk-xxxx
# 或 SILICONFLOW_API_KEY=sk-xxxx
OPENAI_BASE_URL=https://api.siliconflow.cn/v1 # 兼容网关时填写
OPENAI_MODEL=Qwen/Qwen2.5-72B-Instruct # 须与平台控制台模型 ID 一致
# KUNCLAW_TOOL_MODEL=... # VL 模型下工具调用可指定文本模型
# REDIS_URL=... # 可选短期记忆
agentfw 与示例脚本会自动读 .env;已在终端手动设置的变量优先。
三种用法
- 命令行 —
doctor/prompt/chat,会话默认落在./.agent/sessions/ - 示例脚本 —
python examples/customer_service.py(默认多轮) - Windows GUI / EXE —
kunclaw-gui或scripts/build_exe.ps1打包
最小代码可注册 @tool 后构造 BaseAgent 跑一轮(详见仓库 README)。
和「小 Kun」的区别
KunClaw 是通用框架;嵌在本站里的产品助手见 KunSpace AI 助手。
技术栈
Python 3.10+ · OpenAI Async SDK · Typer CLI ·(可选)Tkinter · PyInstaller
