cmsis-dap-cli

English · 中文

English

A standalone command-line tool for working with CMSIS-DAP debug probes and Cortex-M chips over SWD or JTAG. It shares the same engine as the cmsis-dap-mcp server, so you can do everything from a terminal or a script without an AI client: enumerate probes, read/write memory and core registers, control execution, use named peripherals via SVD files, program flash, run J-Link / OpenOCD style scripts, enter an interactive shell, and read live variables and firmware logs (watch, rtt monitor, evr monitor) over SWD/JTAG — no UART needed — with timestamped log export.

Install

Run zero-install with npx, or install globally and use the cmsis-dap-cli command directly:

# zero-install (recommended for quick use and scripts)
npx -y cmsis-dap-cli --help

# or install globally
npm install -g cmsis-dap-cli
cmsis-dap-cli --help

The npm package downloads the correct platform binary automatically (win32/linux/darwin × x64/arm64). Native binaries are also published on GitHub Releases.

Quick start

cmsis-dap-cli chip search STM32F030          # find a built-in chip
cmsis-dap-cli --target STM32F030C8 connect   # connect (or --target-yaml for custom chips)
cmsis-dap-cli --target STM32F030C8 read --address 0x20000000 --width u32 --count 4
cmsis-dap-cli --target STM32F030C8 halt
cmsis-dap-cli --target STM32F030C8 reg get pc
cmsis-dap-cli --target STM32F030C8 flash program --address 0x08000000 --file fw.hex --verify
cmsis-dap-cli --target STM32F030C8 --elf fw.axf watch counter --interval-ms 200 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf rtt monitor --channel 0 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf evr monitor --ctx 0,2 --count 0
cmsis-dap-cli --target STM32F030C8 repl

Commands that need a target auto-connect using the global connection options (--probe-id, --protocol, --speed-khz, --target, --under-reset, --target-yaml). --elf FILE provides symbol names for watch / rtt / evr.

AI-assisted usage

You can also let an AI assistant drive the CLI for you — just describe the task, for example:

Use npx -y cmsis-dap-cli to list probes, connect to STM32F030C8, read memory at 0x20000000, then flash fw.hex with verification.

The assistant runs the CLI and reads the output; same tool, no GUI needed.

Command overview

| Command | Purpose | | --- | --- | | list / info | enumerate probes / show probe info | | connect / disconnect / target | session management | | read / write / verify | memory access and verification | | regs / reg get / reg set | core registers | | status / halt / resume / step / reset | execution control | | bp set/list/clear / wp set/list/clear | breakpoints and watchpoints | | dap read/write | raw DAP (DP/AP) access | | svd list/read/write | named peripheral access (needs --svd FILE) | | flash erase/program | flash erase and programming | | script --file/--text | J-Link / OpenOCD style scripts | | chip generate/list/search | generate target YAML from an FLM, list/search chips | | symbols list/resolve | inspect firmware ELF symbols (needs --elf FILE) | | watch | poll variables live with a refresh interval (needs a session) | | rtt info/monitor | SEGGER RTT up-channel logging (needs --elf or RAM scan) | | evr info/monitor | CMSIS-View Event Recorder decoding (needs --elf) | | dump | non-invasive CPU snapshot (never resets; restores run state) | | tcp-server | remote JSON-RPC server over TCP (reuses one session) | | gdb-server | GDB Remote Serial Protocol stub (non-invasive attach) | | repl | interactive shell |

Use --json for machine-readable output. Flash erase/program run directly; they require a target that defines flash. Monitor commands (watch/rtt monitor/evr monitor) print timestamped lines and export the same log to the current directory by default (--log-dir / --log-file to choose the location); --count 0 runs until Ctrl-C.

Examples

cmsis-dap-cli list
cmsis-dap-cli --target STM32F030C8 connect
cmsis-dap-cli --target STM32F030C8 read --address 0x20000000 --width u32 --count 4
cmsis-dap-cli --target STM32F030C8 flash erase --address 0x08000000 --size 0x10000
cmsis-dap-cli --target STM32F030C8 flash program --address 0x08000000 --file fw.hex --verify
cmsis-dap-cli --svd target.svd svd read GPIOA.ODR.ODR0
cmsis-dap-cli --target STM32F030C8 script --file flash.jlink
cmsis-dap-cli --target STM32F030C8 --elf fw.axf watch counter --count 0 --log-dir logs
cmsis-dap-cli --target STM32F030C8 --elf fw.axf rtt monitor --channel 0,1 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf evr monitor --count 0
cmsis-dap-cli --target STM32F030C8 dump --address 0x20000000 --stack-words 16
cmsis-dap-cli --target STM32F030C8 tcp-server --port 4000
cmsis-dap-cli --target STM32F030C8 gdb-server --port 1337
cmsis-dap-cli --target STM32F030C8 repl

For chips not built into probe-rs, generate a target YAML once from the vendor flash algorithm (FLM), then connect with it:

cmsis-dap-cli chip generate --flm MyChip_64.FLM \
  --flash-start 0x08000000 --flash-size 0x10000 \
  --sram-start 0x20000000 --sram-size 0x2000 \
  --name MYCHIP --output MYCHIP.yaml
cmsis-dap-cli --target-yaml MYCHIP.yaml connect

Documentation

Full documentation (English and Chinese) is published on GitHub Pages:

• English: https://guohj2021.github.io/CMSIS-DAP-MCP/cli.html
• 中文: https://guohj2021.github.io/CMSIS-DAP-MCP/zh/cli.html

License

MIT OR Apache-2.0

中文

面向 CMSIS-DAP 调试探针与 Cortex-M 芯片的独立命令行工具，通过 SWD 或 JTAG 工作。它与 cmsis-dap-mcp 服务器共用同一套引擎，在终端或脚本里 无需 AI 客户端即可完成：枚举探针、读写内存与内核寄存器、控制执行、用 SVD 访问命名外设、烧录 Flash、运行 J-Link / OpenOCD 风格脚本，以及进入交互式 shell。还支持实时变量观察与固件日志读取（watch、rtt monitor、evr monitor），全部走 SWD/JTAG——无需串口——并支持带时间戳的日志导出。

安装

用 npx 零安装直接运行，或全局安装后直接使用 cmsis-dap-cli 命令：

# 零安装（推荐快速试用与脚本调用）
npx -y cmsis-dap-cli --help

# 或全局安装
npm install -g cmsis-dap-cli
cmsis-dap-cli --help

npm 包会自动下载对应平台的二进制（win32/linux/darwin × x64/arm64）。 原生二进制同时发布在 GitHub Releases。

快速上手

cmsis-dap-cli chip search STM32F030          # 查找内置芯片
cmsis-dap-cli --target STM32F030C8 connect   # 连接（自定义芯片用 --target-yaml）
cmsis-dap-cli --target STM32F030C8 read --address 0x20000000 --width u32 --count 4
cmsis-dap-cli --target STM32F030C8 halt
cmsis-dap-cli --target STM32F030C8 reg get pc
cmsis-dap-cli --target STM32F030C8 flash program --address 0x08000000 --file fw.hex --verify
cmsis-dap-cli --target STM32F030C8 --elf fw.axf watch counter --interval-ms 200 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf rtt monitor --channel 0 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf evr monitor --ctx 0,2 --count 0
cmsis-dap-cli --target STM32F030C8 repl

需要目标的命令会自动使用全局连接参数（--probe-id、--protocol、 --speed-khz、--target、--under-reset、--target-yaml）。--elf FILE 为 watch/rtt/evr 提供符号名。

AI 辅助使用

也可以让 AI 助手直接帮你驱动这个 CLI，只需描述任务，例如：

用 npx -y cmsis-dap-cli 列出探针，连接 STM32F030C8，读 0x20000000 处 的内存，然后烧录 fw.hex 并校验。

AI 会运行 CLI 并读取输出；同一工具，无需图形界面。

命令一览

| 命令 | 用途 | | --- | --- | | list / info | 枚举探针 / 查看探针信息 | | connect / disconnect / target | 会话管理 | | read / write / verify | 内存访问与校验 | | regs / reg get / reg set | 内核寄存器 | | status / halt / resume / step / reset | 执行控制 | | bp set/list/clear / wp set/list/clear | 断点与数据观察点 | | dap read/write | 原始 DAP（DP/AP）访问 | | svd list/read/write | 命名外设访问（需 --svd FILE） | | flash erase/program | Flash 擦除与烧录 | | script --file/--text | J-Link / OpenOCD 风格脚本 | | chip generate/list/search | 从 FLM 生成 target YAML、列出/搜索芯片 | | symbols list/resolve | 查看固件 ELF 符号（需 --elf FILE） | | watch | 按刷新间隔实时轮询变量（需会话） | | rtt info/monitor | SEGGER RTT 上行通道日志（需 --elf 或 RAM 扫描） | | evr info/monitor | CMSIS-View Event Recorder 解码（需 --elf） | | dump | 非侵入 CPU 快照（永不复位；默认读取后恢复运行） | | tcp-server | 远程 JSON-RPC TCP 服务器（复用同一会话） | | gdb-server | GDB Remote Serial Protocol stub（非侵入附着） | | repl | 交互式 shell |

--json 输出机器可读结果。Flash 擦除/烧录直接执行；目标必须定义了 Flash。 监控命令（watch/rtt monitor/evr monitor）打印带时间戳的行，并默认把 同样内容导出到当前目录的日志（--log-dir/--log-file 指定位置）； --count 0 一直运行到 Ctrl-C。

示例

cmsis-dap-cli list
cmsis-dap-cli --target STM32F030C8 connect
cmsis-dap-cli --target STM32F030C8 read --address 0x20000000 --width u32 --count 4
cmsis-dap-cli --target STM32F030C8 flash erase --address 0x08000000 --size 0x10000
cmsis-dap-cli --target STM32F030C8 flash program --address 0x08000000 --file fw.hex --verify
cmsis-dap-cli --svd target.svd svd read GPIOA.ODR.ODR0
cmsis-dap-cli --target STM32F030C8 script --file flash.jlink
cmsis-dap-cli --target STM32F030C8 --elf fw.axf watch counter --count 0 --log-dir logs
cmsis-dap-cli --target STM32F030C8 --elf fw.axf rtt monitor --channel 0,1 --count 0
cmsis-dap-cli --target STM32F030C8 --elf fw.axf evr monitor --count 0
cmsis-dap-cli --target STM32F030C8 dump --address 0x20000000 --stack-words 16
cmsis-dap-cli --target STM32F030C8 tcp-server --port 4000
cmsis-dap-cli --target STM32F030C8 gdb-server --port 1337
cmsis-dap-cli --target STM32F030C8 repl

probe-rs 内置库没有的芯片，先用厂商 Flash 算法（FLM）生成一次 target YAML， 再连接：

cmsis-dap-cli chip generate --flm MyChip_64.FLM \
  --flash-start 0x08000000 --flash-size 0x10000 \
  --sram-start 0x20000000 --sram-size 0x2000 \
  --name MYCHIP --output MYCHIP.yaml
cmsis-dap-cli --target-yaml MYCHIP.yaml connect

文档

完整文档（英文与中文）发布在 GitHub Pages：

• 英文：https://guohj2021.github.io/CMSIS-DAP-MCP/cli.html
• 中文：https://guohj2021.github.io/CMSIS-DAP-MCP/zh/cli.html

许可证

MIT OR Apache-2.0