keil
Installation
SKILL.md
Keil MDK 工程构建
本 skill 提供 Keil MDK 工程的发现、Target 枚举、构建、重建、清理能力,并返回可供 jlink/openocd 继续使用的固件产物路径。flash 仅作为兼容入口保留。
配置
环境级配置(skill/config.json)
skill 目录下的 config.json 包含环境级配置,首次使用前确认 uv4_exe 路径正确:
{
"uv4_exe": "C:\\Keil_v5\\UV4\\UV4.exe",
"operation_mode": 1
}
uv4_exe:UV4.exe 完整路径(必填)operation_mode:1直接执行 /2输出风险摘要但不阻塞 /3执行前确认
工程级配置(workspace/.embeddedskills/config.json)
工程级共享配置统一保存在工作区的 .embeddedskills/config.json 中:
{
"keil": {
"project": "",
"target": "",
"log_dir": ".embeddedskills/build"
}
}
project:默认工程路径(相对 workspace),构建成功后会自动更新target:默认 Target 名称,构建成功后会自动更新log_dir:构建日志输出目录,默认.embeddedskills/build
参数解析优先级
参数解析顺序(从高到低):
- CLI 显式参数
- 环境级配置(skill/config.json)
- 工程级配置(.embeddedskills/config.json)
- state.json(上次构建记录)
- 搜索/询问
子命令
| 子命令 | 用途 | 风险 |
|---|---|---|
scan |
搜索当前目录下的 .uvprojx/.uvmpw 工程 | 低 |
targets |
枚举工程中的 Target | 低 |
build |
增量编译 | 中 |
rebuild |
全量重建 | 中 |
clean |
清理工程 | 高 |
flash |
通过 Keil 烧录固件(兼容入口,优先建议使用 jlink/openocd) | 高 |
执行流程
- 读取
config.json,确认uv4_exe路径有效 - 未指定子命令时默认执行
scan - 未提供工程路径时先执行
scan搜索工程 - 同时发现多个工程或多个 Target 时,列出选项让用户选择,绝不自动猜测
build/rebuild/clean按operation_mode决定是否需要确认build/rebuild成功后,尽量从工程配置中解析flash_file/debug_file等产物路径flash仅在最近一次构建成功时允许执行- 所有构建命令输出到日志文件后解析,返回结构化结果
脚本调用
skill 目录下有两个 Python 脚本,使用标准库实现,无额外依赖。
keil_project.py — 工程扫描与 Target 枚举
# 扫描工程
python <skill-dir>/scripts/keil_project.py scan --root <搜索目录> --json
# 枚举 Target
python <skill-dir>/scripts/keil_project.py targets --project <工程路径> --json
keil_build.py — 构建 / 重建 / 清理 / 烧录
python <skill-dir>/scripts/keil_build.py <build|rebuild|clean|flash> \
--uv4 <UV4路径> \
--project <工程路径> \
--target <TargetName> \
--log-dir <日志目录> \
--json
rebuild 额外支持 --clean-first 使用 -cr 而非 -r。
输出格式
所有脚本以 JSON 格式返回,基础字段为 status(ok/error)、action、summary、details,并可能附带 context、artifacts、metrics、state、next_actions、timing。
成功示例:
{
"status": "ok",
"action": "build",
"summary": "build 成功,errors=0 warnings=2",
"details": {
"project": "project.uvprojx",
"target": "Debug",
"log_file": ".build/project-Debug-build.log",
"flash_file": "Objects/project.hex",
"debug_file": "Objects/project.axf"
},
"metrics": { "errors": 0, "warnings": 2, "flash_bytes": 32768, "ram_bytes": 8192 }
}
错误示例:
{
"status": "error",
"action": "flash",
"error": { "code": "build_not_clean", "message": "最近一次构建存在错误,禁止继续烧录" }
}
核心规则
- 不修改工程配置文件(.uvprojx / .uvmpw / .uvoptx)
- 不自动猜测工程路径或 Target,有歧义时必须询问用户
- 参数解析优先级为:CLI 显式参数 > 环境级配置 > 工程级配置 >
.embeddedskills/state.json> 搜索/询问 - 构建成功后优先使用返回的
flash_file/debug_file与jlink/openocd串联 flash前必须确认最近一次构建成功(errors == 0)clean不在自动流程中隐式执行- 构建失败时优先展示首个错误和日志文件路径
- 结果回显中始终包含工程名、Target 名、日志路径;若识别到产物路径也要回显
参考
遇到编译器相关问题时可查阅 references/compiler-notes.md。
Related skills