keil

Original：🇨🇳 Chinese

Translated

3 scriptsChecked / no sensitive code detected

Keil MDK project build tool, used to scan .uvprojx/.uvmpw projects, enumerate Targets, execute build/rebuild/clean and parse build logs, return artifact paths that can be reused by jlink/openocd. The flash subcommand is only retained as a compatibility entry. It is automatically triggered when users mention Keil, MDK, uVision, UV4, Target enumeration, compilation, rebuild, clean, flash, firmware download, or flash. It also supports explicit invocation via /keil. Even if users only say "compile" or "flash to the board", this skill should be triggered as long as the context involves embedded Keil projects.

3installs

Sourcezhinkgit/embeddedskills

Added on2026-05-17

NPX Install

npx skill4agent add zhinkgit/embeddedskills keil

SKILL.md Content (Chinese)

View Translation Comparison →

Keil MDK Project Build

This skill provides discovery, Target enumeration, build, rebuild, and clean capabilities for Keil MDK projects, and returns firmware artifact paths that can be used by

jlink/openocd

.

flash

is only retained as a compatibility entry.

Configuration

Environment-level Configuration (skill/config.json)

The

config.json

in the skill directory contains environment-level configurations. Before first use, confirm that the

uv4_exe

path is correct:

json

{
  "uv4_exe": "C:\\Keil_v5\\UV4\\UV4.exe",
  "operation_mode": 1
}

```
uv4_exe
```
: Full path of UV4.exe (required)
```
operation_mode
```
:
```
1
```
Execute directly /
```
2
```
Output risk summary without blocking /
```
3
```
Confirm before execution

Project-level Configuration (workspace/.embeddedskills/config.json)

Project-level shared configurations are uniformly stored in

.embeddedskills/config.json

in the workspace:

json

{
  "keil": {
    "project": "",
    "target": "",
    "log_dir": ".embeddedskills/build"
  }
}

```
project
```
: Default project path (relative to workspace), which will be automatically updated after successful build
```
target
```
: Default Target name, which will be automatically updated after successful build
```
log_dir
```
: Build log output directory, default is
```
.embeddedskills/build
```

Parameter Parsing Priority

Parameter parsing order (from highest to lowest):

Explicit CLI parameters
Environment-level configuration (skill/config.json)
Project-level configuration (.embeddedskills/config.json)
```
.embeddedskills/state.json
```
(last build record)
Search/query

Subcommands

Subcommand	Purpose	Risk
`scan`	Search for .uvprojx/.uvmpw projects in the current directory	Low
`targets`	Enumerate Targets in the project	Low
`build`	Incremental compilation	Medium
`rebuild`	Full rebuild	Medium
`clean`	Clean the project	High
`flash`	Flash firmware via Keil (compatibility entry, priority recommendation to use jlink/openocd)	High

Execution Flow

Read
```
config.json
```
and confirm that the
```
uv4_exe
```
path is valid
Default to executing
```
scan
```
when no subcommand is specified
Execute
```
scan
```
to search for projects first if no project path is provided
List options for users to choose when multiple projects or multiple Targets are found simultaneously, never guess automatically
```
build/rebuild/clean
```
decide whether confirmation is needed according to
```
operation_mode
```
After successful
```
build/rebuild
```
, try to parse artifact paths such as
```
flash_file
```
/
```
debug_file
```
from project configurations as much as possible
```
flash
```
is only allowed to execute when the last build was successful
All build commands are output to log files and then parsed, returning structured results

Script Invocation

There are two Python scripts in the skill directory, implemented using standard libraries with no additional dependencies.

keil_project.py — Project Scanning and Target Enumeration

bash

# Scan projects
python <skill-dir>/scripts/keil_project.py scan --root <search directory> --json

# Enumerate Targets
python <skill-dir>/scripts/keil_project.py targets --project <project path> --json

keil_build.py — Build / Rebuild / Clean / Flash

bash

python <skill-dir>/scripts/keil_build.py <build|rebuild|clean|flash> \
  --uv4 <UV4 path> \
  --project <project path> \
  --target <TargetName> \
  --log-dir <log directory> \
  --json

rebuild

additionally supports

--clean-first

to use

-cr

instead of

-r

.

Output Format

All scripts return results in JSON format. The basic fields are

status

(ok/error),

action

,

summary

,

details

, and may also include

context

,

artifacts

,

metrics

,

state

,

next_actions

,

timing

.

Success Example:

json

{
  "status": "ok",
  "action": "build",
  "summary": "build succeeded, 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 }
}

Error Example:

json

{
  "status": "error",
  "action": "flash",
  "error": { "code": "build_not_clean", "message": "The last build had errors, flashing is prohibited" }
}

Core Rules

Do not modify project configuration files (.uvprojx / .uvmpw / .uvoptx)
Do not automatically guess project paths or Targets; must ask users when there is ambiguity
Refer to the "Parameter Parsing Priority" section above for parameter parsing priority
After successful build, prioritize using the returned
```
flash_file
```
/
```
debug_file
```
to integrate with
```
jlink/openocd
```
Must confirm that the last build was successful (errors == 0) before executing
```
flash
```
```
clean
```
is not implicitly executed in automatic processes
When build fails, prioritize displaying the first error and log file path
The result echo always includes the project name, Target name, and log path; if artifact paths are identified, they should also be echoed

References

For compiler-related issues, refer to

references/compiler-notes.md

.

keil

NPX Install

Tags

SKILL.md Content (Chinese)

Keil MDK Project Build

Configuration

Environment-level Configuration (skill/config.json)

Project-level Configuration (workspace/.embeddedskills/config.json)

Parameter Parsing Priority

Subcommands

Execution Flow

Script Invocation

keil_project.py — Project Scanning and Target Enumeration

keil_build.py — Build / Rebuild / Clean / Flash

Output Format

Core Rules

References