Back to Details

eide

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

EIDE 嵌入式工程构建

EIDE Embedded Project Building

本 skill 提供 EIDE (Embedded IDE) 工程的发现、构建配置枚举、增量编译、全量重建、清理和 ELF 大小分析能力，并返回可供 
jlink/openocd
继续使用的固件产物路径。
EIDE 是 VS Code 下的嵌入式开发扩展，使用 ARM CC (AC5/AC6) 或 GCC 工具链，通过 
unify_builder
统一构建后端驱动。
This skill provides capabilities for EIDE (Embedded IDE) project discovery, build configuration enumeration, incremental compilation, full rebuild, cleaning, and ELF size analysis, and returns firmware artifact paths that can be used by 
jlink/openocd
.
EIDE is an embedded development extension for VS Code, using ARM CC (AC5/AC6) or GCC toolchains, driven by the unified build backend 
unify_builder
.

配置

Configuration

环境级配置（skill/config.json）

Environment-level Configuration (skill/config.json)

skill 目录下的 
config.json
包含环境级配置，首次使用前确认 
builder_dir
路径正确：
json
{
  "builder_dir": "C:\\Users\\<user>\\.vscode\\extensions\\cl.eide-<version>\\res\\tools\\win32\\unify_builder",
  "builder_exe": "unify_builder.exe",
  "code_exe": "code",
  "toolchain_prefix": "arm-none-eabi-",
  "operation_mode": 1
}
  • builder_dir
    ：EIDE unify_builder 所在目录（必填，位于 VS Code 扩展目录下）
  • builder_exe
    ：builder 可执行文件名，Windows 默认 
    unify_builder.exe
  • code_exe
    ：VS Code CLI 路径，默认从 PATH 查找 
    code
  • toolchain_prefix
    ：用于 size 分析的工具链前缀，默认 
    arm-none-eabi-
  • operation_mode
    ：
    1
    直接执行 / 
    2
    输出风险摘要但不阻塞 / 
    3
    执行前确认
The 
config.json
in the skill directory contains environment-level configurations. Confirm the 
builder_dir
path is correct before first use:
json
{
  "builder_dir": "C:\\Users\\<user>\\.vscode\\extensions\\cl.eide-<version>\\res\\tools\\win32\\unify_builder",
  "builder_exe": "unify_builder.exe",
  "code_exe": "code",
  "toolchain_prefix": "arm-none-eabi-",
  "operation_mode": 1
}
  • builder_dir
    : Directory where EIDE unify_builder is located (required, under the VS Code extension directory)
  • builder_exe
    : Builder executable filename, default is 
    unify_builder.exe
    for Windows
  • code_exe
    : Path to VS Code CLI, defaults to finding 
    code
    from PATH
  • toolchain_prefix
    : Toolchain prefix used for size analysis, default is 
    arm-none-eabi-
  • operation_mode
    : 
    1
    Execute directly / 
    2
    Output risk summary without blocking / 
    3
    Confirm before execution

工程级配置（workspace/.embeddedskills/config.json）

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

工程级共享配置统一保存在工作区的 
.embeddedskills/config.json
中：
json
{
  "eide": {
    "project": "",
    "config": "",
    "log_dir": ".embeddedskills/build"
  }
}
  • project
    ：默认 EIDE 工程根目录（包含 
    .eide/eide.yml
    的目录），构建成功后会自动更新
  • config
    ：默认构建配置名称（对应 eide.yml 中的 ConfigName），构建成功后会自动更新
  • log_dir
    ：构建日志输出目录，默认 
    .embeddedskills/build
Shared project-level configurations are stored uniformly in 
.embeddedskills/config.json
of the workspace:
json
{
  "eide": {
    "project": "",
    "config": "",
    "log_dir": ".embeddedskills/build"
  }
}
  • project
    : Default root directory of EIDE project (directory containing 
    .eide/eide.yml
    ), will be automatically updated after successful build
  • config
    : Default build configuration name (corresponding to ConfigName in eide.yml), will be automatically updated after successful build
  • log_dir
    : Build log output directory, default is 
    .embeddedskills/build

参数解析优先级

Parameter Parsing Priority

参数解析顺序（从高到低）：
  1. CLI 显式参数
  2. 环境级配置（skill/config.json）
  3. 工程级配置（.embeddedskills/config.json）
  4. .embeddedskills/state.json
    （上次构建记录）
  5. 搜索/询问
Parameter parsing order (from highest to lowest):
  1. Explicit CLI parameters
  2. Environment-level configuration (skill/config.json)
  3. Project-level configuration (.embeddedskills/config.json)
  4. .embeddedskills/state.json
    (last build record)
  5. Search/query

子命令

Subcommands

子命令用途风险
scan
搜索当前目录下的 EIDE 工程（含 
.eide/eide.yml
的目录）		低
configs
枚举工程中的构建配置低
build
增量编译中
rebuild
全量重建中
clean
清理构建产物高
size
分析 ELF 文件大小（text/data/bss 和内存使用）低
SubcommandPurposeRisk
scan
Search for EIDE projects in the current directory (directories containing 
.eide/eide.yml
)		Low
configs
Enumerate build configurations in the projectLow
build
Incremental compilationMedium
rebuild
Full rebuildMedium
clean
Clean build artifactsHigh
size
Analyze ELF file size (text/data/bss and memory usage)Low

执行流程

Execution Flow

  1. 读取 
    config.json
    ，确认 
    builder_dir
    路径有效
  2. 未指定子命令时默认执行 
    scan
  3. 未提供工程路径时先执行 
    scan
    搜索工程
  4. 同时发现多个工程或多个配置时，列出选项让用户选择，绝不自动猜测
  5. build/rebuild/clean
    按 
    operation_mode
    决定是否需要确认
  6. build/rebuild
    成功后，从构建目录解析 
    elf_file
    / 
    hex_file
    等产物路径
  7. 所有构建命令基于 
    builder.params
    调用 
    unify_builder
    ，输出到日志文件后解析
  8. size
    默认分析最近一次构建产物的 .elf 文件
  1. Read 
    config.json
    and confirm the 
    builder_dir
    path is valid
  2. Default to executing 
    scan
    when no subcommand is specified
  3. Execute 
    scan
    to search for projects if no project path is provided
  4. List options for user selection when multiple projects or configurations are found simultaneously, never guess automatically
  5. build/rebuild/clean
    decides whether confirmation is needed based on 
    operation_mode
  6. After successful 
    build/rebuild
    , parse artifact paths like 
    elf_file
    / 
    hex_file
    from the build directory
  7. All build commands call 
    unify_builder
    based on 
    builder.params
    , output to log files then parse
  8. size
    defaults to analyzing the .elf file from the most recent build

脚本调用

Script Invocation

skill 目录下有 Python 脚本，使用标准库 + PyYAML 实现。
Python scripts are available in the skill directory, implemented with standard libraries + PyYAML.

eide_project.py — 工程扫描与配置枚举

eide_project.py — Project Scanning and Configuration Enumeration

bash
undefined
bash
undefined

扫描工程

Scan projects

python <skill-dir>/scripts/eide_project.py scan --root <搜索目录> --json
python <skill-dir>/scripts/eide_project.py scan --root <search directory> --json

枚举构建配置

Enumerate build configurations

python <skill-dir>/scripts/eide_project.py configs --project <工程目录> --json
undefined
python <skill-dir>/scripts/eide_project.py configs --project <project directory> --json
undefined

eide_build.py — 构建 / 重建 / 清理

eide_build.py — Build / Rebuild / Clean

bash
python <skill-dir>/scripts/eide_build.py <build|rebuild|clean> \
  --builder-dir <unify_builder目录> \
  --project <工程根目录> \
  --config <配置名称> \
  --log-dir <日志目录> \
  --json
rebuild
额外支持 
--clean-first
先清理再重建。
bash
python <skill-dir>/scripts/eide_build.py <build|rebuild|clean> \
  --builder-dir <unify_builder directory> \
  --project <project root directory> \
  --config <configuration name> \
  --log-dir <log directory> \
  --json
rebuild
additionally supports 
--clean-first
to clean before rebuilding.

eide_size.py — ELF 大小分析

eide_size.py — ELF Size Analysis

bash
undefined
bash
undefined

基本分析

Basic analysis

python <skill-dir>/scripts/eide_size.py analyze
--elf <elf文件路径>
--toolchain-prefix arm-none-eabi-
--json
python <skill-dir>/scripts/eide_size.py analyze
--elf <elf file path>
--toolchain-prefix arm-none-eabi-
--json

对比分析

Comparative analysis

python <skill-dir>/scripts/eide_size.py compare
--elf <elf文件1>
--compare <elf文件2>
--toolchain-prefix arm-none-eabi-
--json
undefined
python <skill-dir>/scripts/eide_size.py compare
--elf <elf file 1>
--compare <elf file 2>
--toolchain-prefix arm-none-eabi-
--json
undefined

输出格式

Output Format

所有脚本以 JSON 格式返回，基础字段为 
status
（ok/error）、
action
、
summary
、
details
，并可能附带 
context
、
artifacts
、
metrics
、
state
、
next_actions
、
timing
。
成功示例：
json
{
  "status": "ok",
  "action": "build",
  "summary": "build 成功，errors=0 warnings=2",
  "details": {
    "project": "Vendor/EIDE",
    "config": "W20_Mainboard",
    "build_dir": "build/W20_Mainboard",
    "elf_file": "build/W20_Mainboard/MDK-ARM_F403A.elf",
    "hex_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "log_file": ".embeddedskills/build/MDK-ARM_F403A-W20_Mainboard-build.log"
  },
  "artifacts": {
    "elf_file": "build/W20_Mainboard/MDK-ARM_F403A.elf",
    "hex_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "flash_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "debug_file": "build/W20_Mainboard/MDK-ARM_F403A.elf"
  },
  "metrics": { "errors": 0, "warnings": 2, "flash_bytes": 32768, "ram_bytes": 8192 }
}
错误示例：
json
{
  "status": "error",
  "action": "build",
  "error": { "code": "builder_not_found", "message": "unify_builder.exe 不存在，请确认 EIDE 扩展已安装" }
}
All scripts return in JSON format, with basic fields 
status
(ok/error), 
action
, 
summary
, 
details
, and may include 
context
, 
artifacts
, 
metrics
, 
state
, 
next_actions
, 
timing
.
Success example:
json
{
  "status": "ok",
  "action": "build",
  "summary": "build succeeded, errors=0 warnings=2",
  "details": {
    "project": "Vendor/EIDE",
    "config": "W20_Mainboard",
    "build_dir": "build/W20_Mainboard",
    "elf_file": "build/W20_Mainboard/MDK-ARM_F403A.elf",
    "hex_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "log_file": ".embeddedskills/build/MDK-ARM_F403A-W20_Mainboard-build.log"
  },
  "artifacts": {
    "elf_file": "build/W20_Mainboard/MDK-ARM_F403A.elf",
    "hex_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "flash_file": "build/W20_Mainboard/MDK-ARM_F403A.hex",
    "debug_file": "build/W20_Mainboard/MDK-ARM_F403A.elf"
  },
  "metrics": { "errors": 0, "warnings": 2, "flash_bytes": 32768, "ram_bytes": 8192 }
}
Error example:
json
{
  "status": "error",
  "action": "build",
  "error": { "code": "builder_not_found", "message": "unify_builder.exe does not exist, please confirm EIDE extension is installed" }
}

核心规则

Core Rules

  • 不修改 
    .eide/eide.yml
    或任何 EIDE 工程配置文件
  • 不自动猜测工程路径或构建配置，有歧义时必须询问用户
  • 参数解析优先级详见上方"参数解析优先级"章节
  • 构建成功后优先使用返回的 
    flash_file
    / 
    debug_file
    与 
    jlink/openocd
    串联
  • clean
    不在自动流程中隐式执行
  • 构建失败时优先展示首个错误和日志文件路径
  • 结果回显中始终包含工程名、配置名、构建目录路径；构建成功时优先回显产物路径
  • EIDE 工程以包含 
    .eide/eide.yml
    的目录为根目录
  • Do not modify 
    .eide/eide.yml
    or any EIDE project configuration files
  • Never automatically guess project paths or build configurations; must ask the user when there is ambiguity
  • Refer to the "Parameter Parsing Priority" section above for parameter parsing order
  • After successful build, prefer to use the returned 
    flash_file
    / 
    debug_file
    to integrate with 
    jlink/openocd
  • clean
    is not implicitly executed in automatic processes
  • When build fails, prioritize displaying the first error and log file path
  • Project name, configuration name, and build directory path are always included in result echoes; artifact paths are prioritized in echoes when build succeeds
  • EIDE projects take the directory containing 
    .eide/eide.yml
    as the root directory

与 Keil 工程的关系

Relationship with Keil Projects

本项目中的 EIDE 工程与 Keil MDK 工程共享相同的源码和 ARM CC 工具链（
D:\Keil_V543\ARM\ARMCLANG
）。EIDE 工程通过 
eide.yml
描述工程结构，
builder.params
由 EIDE 自动生成并供 
unify_builder
使用。两者的构建产物（.axf/.hex/.elf）格式兼容，可互换使用。
EIDE projects in this project share the same source code and ARM CC toolchain (
D:\Keil_V543\ARM\ARMCLANG
) as Keil MDK projects. EIDE projects describe project structure via 
eide.yml
, and 
builder.params
is automatically generated by EIDE for use by 
unify_builder
. The build artifacts (.axf/.hex/.elf) of the two are compatible and interchangeable.

参考

References

  • EIDE 扩展：在 VS Code 中搜索 
    cl.eide
    安装
  • eide.yml
    格式：见 EIDE 扩展文档
  • builder.params
    ：由 EIDE 自动生成，位于 
    build/<ConfigName>/builder.params
  • EIDE Extension: Search for 
    cl.eide
    in VS Code to install
  • eide.yml
    Format: See EIDE Extension Documentation
  • builder.params
    : Automatically generated by EIDE, located at 
    build/<ConfigName>/builder.params