Skip to content
Back to search

auto-embedded

Primary embedded development skills

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/duncanyoung-1--auto-embedded/badge.svg)](/listings/duncanyoung-1--auto-embedded)

HTML

<a href="/listings/duncanyoung-1--auto-embedded"><img src="/api/listings/duncanyoung-1--auto-embedded/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

SKILL.md · Manifest · 109 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. ---
  2. name: auto-embedded
  3. description: "全平台嵌入式 AI 开发框架(对标 Trellis):把 RIPER-5 五阶段协议 + 四文件记忆 + 分层架构门禁 + Scout/Builder/Verifier 多 Agent + 24 个工具调用技能(build/flash/debug/serial/can/modbus/visa/static/memory/rtos/scons),做成『装进工程、项目级 hook 必然运行、按角色自动注入相关 spec、REVIEW 学习回流』的闭环,并一次写、全平台交付(Claude/Cursor/Codex/OpenCode/Copilot/Gemini/Windsurf)。用 `aemb init` 在固件工程里安装运行时与各平台注入接线。当用户要为 STM32/ESP32/GD32/MSPM0/RISC-V/国产 MCU 工程搭建可复用开发规范基座、让约定自动注入、跨会话可恢复、编译/烧录/调试一体化,或问到 auto-embedded/aemb/spec 注入/项目级 hook/全平台时使用。不适用于纯 Web/移动/桌面软件或与硬件无关的通用 C/C++。"
  4. keywords: "auto-embedded, aemb, 全平台嵌入式框架, 多平台, spec 注入, 项目级 hook, RIPER-5, 四文件记忆, 分层架构门禁, Scout Builder Verifier, hw-lock, promote 回流, 工具技能, build flash debug, STM32, ESP32, GD32, MSPM0, Claude Cursor Codex OpenCode Copilot Gemini Windsurf"
  5. ---
  6. # auto-embedded —— 装进工程、跨 7 个 AI 平台的 RIPER-5 + spec 注入 + 工具链框架
  7. ## 它是什么(与 embedded-dev 的区别)
  8. `embedded-dev` 是**全局单 skill 插件**:refs 全局只读、靠模型自觉、frontmatter hook 对 user-skill 不生效、且只在 Claude 可用。
  9. `auto-embedded` 对标 Trellis,把同一套能力做成**装进每个固件工程、跨多个 AI 编码平台的基座**:
  10. - **项目级 hook 必然运行**:`aemb init` 把注入接线写进工程的各平台配置(Claude `settings.json`、Cursor/Codex/Copilot `hooks.json`、Gemini `settings.json`、OpenCode JS 插件…),AI 工具必然执行(不依赖 skill frontmatter hook)。
  11. - **项目级 spec 库**:`.auto-embedded/spec/`(分层、可版本化、可覆盖),而非全局只读 refs。
  12. - **相关性自动注入**:会话起始注入阶段+spec 索引;派 Scout/Builder/Verifier 时按 per-task `*.jsonl` 只 push 该角色相关的 spec。
  13. - **学习回流**:REVIEW 用 `task.py promote` 把决策/约定/坑沉淀回 spec,跨会话/跨任务复利。
  14. - **工具链一体化**:24 个工具调用技能(编译/烧录/调试/串口/CAN/Modbus/VISA/静态分析/内存分析/RTOS/检索),脚本随框架装进 `.auto-embedded/tools/`,全平台都能调。
  15. - **一次写、全平台交付**:同一套 common 命令/技能/Agent 经占位符渲染成各平台正确语法,由各平台 configurator 写对应注入接线。
  16. ## 支持平台
  17. **已打通(7)**:`claude` `cursor` `codex` `opencode` `copilot` `gemini` `windsurf`
  18. **预留位(7,注册表就绪、configurator 待实现)**:`kilo` `kiro` `antigravity` `qoder` `codebuddy` `droid` `pi`
  19. ## 第一步:判断工程是否已安装
  20. 主交付物是固件且在某个工程目录时,**先查该工程根有没有 `.auto-embedded/`**:
  21. - **没有** → 新接入,跑一次 init:
  22. ```bash
  23. aemb init <工程根> -u <开发者名> --platforms claude,cursor,codex # 或 --claude --cursor …,或 --all
  24. ```
  25. 会脚手架 `.auto-embedded/`(运行时内核 + spec + 24 工具脚本)+ 写各平台注入接线/agents/skills/commands + 智能合并配置文件(settings.json/hooks.json/config.toml/package.json,只增删 aemb 片段)。
  26. 安装后在该工程**新开一个会话**,注入 hook 就会自动带出现场。
  27. - **已有** → 接线已在注入现场。读注入的 `<auto-embedded-session>` 块 + `.auto-embedded/workflow.md`,按 RIPER-5 推进。
  28. 日常驱动用 **slash 命令 / 技能**(init 已写进工程):
  29. `/aemb:start <标题>` · `/aemb:continue` · `/aemb:finish-work` · `/aemb:status`(Cursor 等为 `/aemb-…`,Codex 为 `$aemb-…`)。
  30. ## 命令速查
  31. **脚手架**(`aemb` = npm 全局安装出的命令;或 `node dist/cli/index.js`):
  32. ```
  33. aemb init <工程> -u <名> [--platforms a,b | --<平台> … | --all] # 安装运行时 + 选定平台接线
  34. aemb update <工程> # 升级 managed(脚本/hooks/agents/commands/工具),保留 spec/tasks/用户改动
  35. aemb doctor <工程> # 体检 7 平台接线
  36. aemb check <工程> [--arch|--hw|--spec|--json] # 机械门禁
  37. aemb backup <工程> # 备份 .auto-embedded/
  38. aemb uninstall <工程> # 按 manifest 剥除 aemb 片段 + 删 .auto-embedded(先备份)
  39. ```
  40. **底层脚本**(slash 命令内部调它,也可直接用):
  41. ```
  42. python .auto-embedded/scripts/task.py start "<标题>" | phase PLAN | select builder spec/architecture/index.md "原因" | promote conventions "<学习>" | list | journal "<摘要>" | archive
  43. ```
  44. ## 工作流(RIPER-5,权威在工程的 workflow.md)
  45. 每条回复开头声明 `[MODE: 阶段]`。默认 RESEARCH 起;含写代码的清单项进 EXECUTE 前必须过 PLAN 审查门并获用户确认。
  46. | 阶段 | 干什么 | 角色 |
  47. |---|---|---|
  48. | RESEARCH | 查芯片/库、读 spec、引脚规划写 hw-lock.yaml、证据写 research.md | Scout(只读) |
  49. | INNOVATE | 评候选方案 | — |
  50. | PLAN | 出实施清单(路径+签名+寄存器+验证标准+review+层级);零占位符 | — |
  51. | EXECUTE | 按轮次最小实现,每轮带 trace_id+验证标准+证据;本地 git 快照 | Builder(单写者) |
  52. | REVIEW | 验证门→硬件合规(对照 hw-lock)→分层门禁→**promote 回流** | Verifier(只审) |
  53. 多文件/长任务按 Scout→Builder→Verifier 分权,同一时刻只一个 Builder 写。
  54. 派 Agent:`aemb-scout|aemb-builder|aemb-verifier`,hook(push 平台)或 prelude(pull 平台 Codex/Copilot/Gemini 子 Agent)会按角色注入相关 spec。
  55. ## 工具调用技能(24,全量目录)
  56. > 24 是**全量目录**。`aemb init` 按工程 profile(芯片/构建/OS 探测)精简装:例如纯 STM32+Keil 工程只装 `build-keil`/`flash-*`/`debug-*` 等相关技能,不装 `build-idf`/`build-scons`。全量装用 `aemb init --full`;事后增减用 `aemb add/remove <pack>`;查当前装了什么用 `aemb profile`。
  57. 脚本随框架装进 `.auto-embedded/tools/<skill>/scripts/`,按需用 `python` 调;SKILL 描述自动触发:
  58. - 编译:`build-cmake` `build-iar` `build-idf` `build-keil` `build-makefile` `build-platformio` `build-scons`(RT-Thread)
  59. - 烧录:`flash-idf` `flash-jlink` `flash-keil` `flash-openocd` `flash-platformio`
  60. - 调试:`debug-gdb-openocd` `debug-jlink` `debug-platformio`
  61. - 观测/分析:`serial-monitor` `static-analysis` `memory-analysis` `rtos-debug`
  62. - 总线/仪器:`can-debug` `modbus-debug` `visa-debug`
  63. - 驱动:`peripheral-driver`(开源驱动搜索→评估→适配/骨架;方法论见 `.auto-embedded/refs/stm32-hal/`)
  64. - 检索:`zhihu-search`(知乎站内问答检索)
  65. ## 知识库与专项流程(自上一代 embedded-dev 全量吸收,按需加载)
  66. 上一代 `embedded-dev` 的离线知识库与专项流程已 bundle 进运行时,随 `aemb init` 装入工程,**按需读取**(不自动全量注入,防撑爆上下文):
  67. - `.auto-embedded/refs/`(80+ 篇)—— STM32/GD32 API、引脚规划、IMU、故障分类、编码规范、驱动移植、竞赛清单/契约…总览见 `refs/index.md`;`refs/stm32-hal/` 为 STM32 HAL 方法论 + BSP 模板领域包。
  68. - `.auto-embedded/modes/`(13 个专项流程)—— RIPER-5 主干外的专项工作流:`competition`(比赛 6-Agent + CP 门禁)、`datasheet-lookup`、`netlist-lookup`、`gd32-board`、`mspm0-board`、`rtos-rtthread`、`seekfree-lib`、`matlab-*`、`industrial-data-acquisition`、`mcp-healthcheck`、`workflow-orchestration`。总览见 `modes/index.md`。
  69. **比赛模式**:用户说"启用比赛模式"时进入 `.auto-embedded/modes/competition.md`,由 6 个专职 subagent 并行推进:
  70. `embedded-arch`(唯一决策者/路由/集成)· `embedded-drv`(驱动)· `embedded-alg`(算法)· `embedded-matlab`(MATLAB 仿真)· `embedded-qa`(验证门)· `embedded-report`(报告),配合 CP-0~CP-5 决策门与 Defect Ticket 回派协议。 并行编排完整支持 Claude;其余平台装入 agent 定义但派发受限(Codex 禁 spawn、Copilot 无 Task 映射),降级为单代理按 modes/competition.md 顺序走 CP 门禁。日常 RIPER-5 仍用 `aemb-scout/builder/verifier` 三角色。
  71. ## spec 库(项目级,可演进)
  72. `.auto-embedded/spec/` 五层(见各 `index.md`):`architecture`(六层模型+ARCH-1~8)、`conventions`(证据优先/复用优先/ISR/临界区/Git 快照)、`hardware`(事实基线 + 机器可读 `hw-lock.yaml`)、`guides`(思维清单)、`governance`(记忆边界)。
  73. 新增/改约定就改对应 `index.md`;REVIEW 用 `promote` 沉淀,下次自动注入。
  74. ## 架构(开发者向)
  75. `src/types/ai-tools.ts`(平台注册表数据)→ `src/configurators/*`(每平台行为 + `shared.ts` 占位符渲染 + `merge.ts` 配置合并 + `hooks.ts` 共享 hook 分发)→ `templates/`(`common/` 共享 body、`shared-hooks/` 三个 Python hook、`<平台>/` 私有模板、`auto-embedded/` 运行时内核 + 工具脚本)。新增平台:加注册表条目 + 写 `configurators/<平台>.ts` + 在 `configurators/index.ts` 注册。
  76. ## 自测
  77. ```
  78. bash tests/test-auto-embedded.sh
  79. ```
  80. 临时工程里 `init --all` 并断言整条闭环(7 平台脚手架/doctor/幂等/内核/工具脚本 shared 导入/SessionStart+面包屑+子 Agent 注入/卸载全清)。
README.md · README · 165 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <img src="./assets/logo-h.svg" alt="米醋电子工作室 MCU Electronics Studio" width="420" />
  3. </p>
  4. <p align="center">
  5. <strong>米醋嵌入式AI+</strong><br/>
  6. 不为嵌入式AI赚钱,以培养新一代嵌入式AI工程师为己任
  7. </p>
  8. <h1 align="center">auto-embedded</h1>
  9. <p align="center">
  10. <strong>让 AI 编码助手可靠地写嵌入式固件的开箱即用工程框架。</strong><br/>
  11. <sub>AI 写嵌入式三宗罪:乱猜引脚、上下文断档、空口宣称修好。auto-embedded 一条命令装进你的固件工程——强制五阶段流程、冻结的硬件资源表、落盘的任务记忆、编译/烧录/调试工具技能、80+ 篇离线嵌入式知识库——一次接线,7 个 AI 平台同时生效。</sub>
  12. </p>
  13. <p align="center">
  14. <a href="./README_EN.md">English</a> •
  15. <a href="./docs/quick-start_CN.md">快速开始</a> •
  16. <a href="./docs/concepts_CN.md">核心概念</a> •
  17. <a href="./docs/architecture_CN.md">架构原理</a> •
  18. <a href="#faq">常见问题</a>
  19. </p>
  20. <p align="center">
  21. <a href="https://www.npmjs.com/package/auto-embedded"><img src="https://img.shields.io/npm/v/auto-embedded.svg?style=flat-square&color=2563eb" alt="npm version" /></a>
  22. <a href="https://www.npmjs.com/package/auto-embedded"><img src="https://img.shields.io/npm/dw/auto-embedded?style=flat-square&color=cb3837&label=downloads" alt="npm downloads" /></a>
  23. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-PolyForm%20Noncommercial-16a34a.svg?style=flat-square" alt="license" /></a>
  24. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded/stargazers"><img src="https://img.shields.io/github/stars/DunCanYounG-1/MICU-auto-embedded?style=flat-square&color=eab308" alt="stars" /></a>
  25. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded/issues"><img src="https://img.shields.io/github/issues/DunCanYounG-1/MICU-auto-embedded?style=flat-square&color=e67e22" alt="open issues" /></a>
  26. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded/pulls"><img src="https://img.shields.io/github/issues-pr/DunCanYounG-1/MICU-auto-embedded?style=flat-square&color=9b59b6" alt="open PRs" /></a>
  27. <a href="https://deepwiki.com/DunCanYounG-1/MICU-auto-embedded"><img src="https://img.shields.io/badge/Ask-DeepWiki-blue?style=flat-square" alt="Ask DeepWiki" /></a>
  28. <a href="https://chatgpt.com/?q=Explain+the+project+DunCanYounG-1/MICU-auto-embedded+on+GitHub"><img src="https://img.shields.io/badge/Ask-ChatGPT-74aa9c?style=flat-square&logo=openai&logoColor=white" alt="Ask ChatGPT" /></a>
  29. </p>
  30. ## 为什么需要它?
  31. | 能力 | 改变了什么 |
  32. | --- | --- |
  33. | **强制五阶段流程** | 每条回复声明所处阶段(`[MODE: RESEARCH]`…)。计划经你审查后才能写代码——不再"上来就改"。 |
  34. | **硬件资源锁** | 引脚 / DMA / 中断优先级先冻结进 `hw-lock.yaml` 再编码。冲突由脚本 exit code 拦截,不靠 AI 自觉。 |
  35. | **任务记忆落盘** | 进度、改动、研究发现持久化在 `.auto-embedded/`。新会话自动注入现场、"五问重启"接着干——上下文断档不再杀死任务。 |
  36. | **证据门禁** | 屏蔽"应该没问题"。必须出示编译输出 / 串口日志 / 手册页码才算完成。 |
  37. | **项目规范自我进化** | 每个任务收尾把学到的(决策、坑、约定)沉淀回工程规范库,下次自动注入。 |
  38. | **工具链与知识库内置** | 24 个工具技能(编译/烧录/调试/串口/总线/分析)+ 80+ 篇离线知识库——按工程 profile(芯片/构建/OS 探测)精简装,只给相关的(`aemb profile` 查、`aemb add` 增)——AI 查表干活,不瞎编寄存器。 |
  39. | **7 平台一次接线** | 规则写一次,`aemb init` 按各平台原生语法和钩子机制装进 Claude Code、Cursor、Codex、OpenCode、Copilot、Gemini CLI、Windsurf。 |
  40. ## 前置要求
  41. - **Node.js** >= 20
  42. - **Python** >= 3.9
  43. ## 快速开始
  44. ```bash
  45. # 1. 全局安装 CLI
  46. npm install -g auto-embedded
  47. # 2. 装进你的固件工程(--platforms 选你在用的 AI 工具,或 --all 全装)
  48. aemb init /path/to/firmware-project -u 你的名字 --platforms claude,cursor
  49. # 3. 在该工程用对应 AI 工具新开会话 —— 现场自动注入,直接说需求即可
  50. ```
  51. 各平台命令语法、日常命令、维护操作(`doctor` / `update` / `uninstall`)见 [快速开始指南](./docs/quick-start_CN.md)。
  52. ## 怎么用
  53. 用自然语言说需求,框架自动路由:
  54. | 你说 | 它做什么 |
  55. | --- | --- |
  56. | `帮我给 STM32F103 移植一个 SSD1306 驱动` | 先搜本地知识库 → 评估开源驱动 → 移植适配(复用优先,不造轮子) |
  57. | `查手册,确认 F103 ADC 时钟上限` | 查手册流程:搜 PDF → 提取参数 → 写回代码注释并带页码 |
  58. | `USART1 中断为什么不触发` | 证据优先排障:先查寄存器配置 / NVIC / 网表,再动代码 |
  59. | `启用比赛模式,做一个平衡车控制系统` | 6 个专职 AI 角色并行:冻结引脚与接口契约 → MATLAB 仿真过门 → 驱动+算法分头推进 |
  60. ## 工作原理
  61. auto-embedded 用平台钩子和角色化子代理跑一个强约束循环:
  62. 1. **RESEARCH** —— 识别芯片、查内置知识库、引脚规划写入 `hw-lock.yaml`。禁止改代码。
  63. 2. **INNOVATE → PLAN** —— 对比方案,产出逐项实施清单(路径 + 函数签名 + 验证标准)。含代码的计划需你确认。
  64. 3. **EXECUTE** —— 单写者 Builder 一轮一个改动点、每项给证据;每步确认后本地 git 快照。
  65. 4. **REVIEW** —— 先跑机械门禁(`arch-check` 分层 + 硬件冲突 + 规范完整性),再实测验证;经验沉淀回 `spec/`。
  66. 会话开始、每轮对话、每次派子代理都经**项目级钩子**注入恰好相关的上下文——由各平台钩子机制保证必然发生,不靠模型记性。详见 [架构原理](./docs/architecture_CN.md)。
  67. ## 资源导航
  68. | 需求 | 链接 |
  69. | --- | --- |
  70. | 安装、首个任务、各平台语法 | [快速开始](./docs/quick-start_CN.md) |
  71. | RIPER-5、硬件锁、记忆机制、比赛模式 | [核心概念](./docs/concepts_CN.md) |
  72. | 注入闭环、仓库结构、扩展平台 | [架构原理](./docs/architecture_CN.md) |
  73. | 安装细节与排障 | [INSTALL.md](./INSTALL.md) |
  74. | AI 自身遵循的协议 | [SKILL.md](./SKILL.md) |
  75. ## FAQ
  76. <details>
  77. <summary><strong>和自己手写 <code>CLAUDE.md</code> / <code>AGENTS.md</code> 有什么区别?</strong></summary>
  78. 静态规则文件靠模型自己读、自己记——越写越臃肿,还会悄悄掉出上下文。auto-embedded 通过平台钩子**分场景注入**(会话开始 / 每轮 / 按子代理角色),用**机械检查**(脚本 exit code)守门,任务状态落盘可跨会话续作。
  79. </details>
  80. <details>
  81. <summary><strong>只能用于 Claude 吗?</strong></summary>
  82. 不是。一次 `aemb init` 同时交付 Claude Code、Cursor、Codex、OpenCode、GitHub Copilot、Gemini CLI、Windsurf,各自用原生配置和钩子机制接线;另有 7 个平台预留注册位。
  83. </details>
  84. <details>
  85. <summary><strong>会动我现有的代码吗?</strong></summary>
  86. 不会。只写入 `.auto-embedded/` 和各平台配置接线,全部记录在 manifest 里;`aemb uninstall` 可干净剥离(先自动备份)。
  87. </details>
  88. <details>
  89. <summary><strong>它能保证 AI 不犯错吗?</strong></summary>
  90. 不能——也不假装能。它做的是大幅降低概率(证据要求、冻结硬件表、机械分层检查),并在高风险点强制暂停问你,而不是放任 AI 猜。硬件设计与物理实测仍然靠人。
  91. </details>
  92. <details>
  93. <summary><strong>和老项目 <code>embedded-dev</code> 什么关系?</strong></summary>
  94. 本仓库就是它的继任者——原地更名。上一代 Claude 单插件的协议、知识库、比赛模式已全量吸收;原独立旧仓归档于 [auto-embedded-legacy](https://github.com/DunCanYounG-1/auto-embedded-legacy),旧链接自动重定向。
  95. </details>
  96. <details>
  97. <summary><strong>哪些事它不做?</strong></summary>
  98. 原理图/PCB 设计、器件选型、焊接、示波器实测、量产认证。它是**固件软件链路**的工程执行框架——边界诚实,见 [核心概念](./docs/concepts_CN.md#能力边界)。
  99. </details>
  100. ## Star History
  101. [![Star History Chart](https://api.star-history.com/svg?repos=DunCanYounG-1/MICU-auto-embedded&type=Date)](https://star-history.com/#DunCanYounG-1/MICU-auto-embedded&Date)
  102. ## 社区与资源
  103. - [GitHub Issues](https://github.com/DunCanYounG-1/MICU-auto-embedded/issues)
  104. - [npm 包](https://www.npmjs.com/package/auto-embedded)
  105. - 感谢 [LinuxDo](https://linux.do/) 社区支持
  106. ## 许可协议
  107. 本项目采用 **PolyForm Noncommercial License 1.0.0**([LICENSE](https://github.com/DunCanYounG-1/MICU-auto-embedded/blob/main/LICENSE) · [官方协议](https://polyformproject.org/licenses/noncommercial/1.0.0))。
  108. **个人自用、学习研究、教育与公益用途免费**;**任何商业用途须另行获取商业授权**——包括但不限于:盈利性公司在内部使用、把本项目嵌入商业产品或服务、用它承接付费项目等。是否构成"商业用途"以协议的 [Noncommercial Purposes](https://github.com/DunCanYounG-1/MICU-auto-embedded/blob/main/LICENSE) 一节为准。
  109. 商业授权咨询请通过 [GitHub Issues](https://github.com/DunCanYounG-1/MICU-auto-embedded/issues) 联系作者。
  110. <p align="center">
  111. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded">官方仓库</a> •
  112. <a href="https://github.com/DunCanYounG-1/MICU-auto-embedded/blob/main/LICENSE">PolyForm Noncommercial 1.0.0</a> •
  113. 作者 <a href="https://github.com/DunCanYounG-1">DuncanY</a> · 架构对标 <a href="https://github.com/mindfold-ai/Trellis">Trellis</a>
  114. </p>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.