Configure EMBEDDER.md

EMBEDDER.md is your project’s guide for Embedder. Keep it at the repository root and use it for exact commands, hardware constraints, and conventions that should apply across conversations.

Create or refresh the guide

Run /init in the project’s chat:

/init

Embedder inspects the repository and asks you to verify:

Target hardware
Build and test commands
Debug and deployment setup
Bench equipment and integrations
Quality rules and conventions

Correct any uncertain target, command, or pin assignment. You can confirm a command without running it; optional build, flash, or hardware validation is a separate choice. When setup is complete, review EMBEDDER.md. A command should be described as verified only if it was actually checked.

Keep manual notes outside the generated block

/init refreshes the section between these markers:

<!-- embedder:init:start -->
...generated project guide...
<!-- embedder:init:end -->

Keep your own notes outside the markers so a later /init preserves them. Do not duplicate the markers or rename fields generated by setup.

Record actionable instructions

A useful guide identifies:

The exact board, MCU, SDK or RTOS, and toolchain.
Build, clean, test, flash, and debug commands, with expected artifacts.
The intended probe, serial port, baud rate, and power limits.
Generated or vendor files that should not be edited.
Required checks and the result that counts as success.
Unresolved setup items that need attention before a workflow can run.

For example, a manual note might say:

## Board validation

Use the Rev C sensor board. UART runs at 115200 baud.
A successful smoke test prints "self-test: pass" within 10 seconds of reset.
Do not change the bootloader region or enable the heater during a smoke test.

Edit connection settings

Setup can generate fields such as:

<COMMANDS>
build_command = cmake --build build
serial_port = /dev/ttyUSB0
serial_baudrate = 115200
</COMMANDS>

Use your project’s real values. Record a selection rule when ports differ between workstations, and update the guide when the board or build layout changes. Name required environment variables without putting their secret values in this file. For reusable procedures beyond one project, create a skill.

Check that the guide works

Ask Embedder to read the guide, identify the selected target, and run one recorded check. If it reports an outdated command or missing tool, correct setup before asking for a larger change. Start a new conversation if an external edit is not reflected in the current chat.

Get started

Core concepts

Complex workflows

Monitor and debug

Project tools

Customize

Integrations

Automation

CLI

Reference

Configure EMBEDDER.md

Create or refresh the guide

Keep manual notes outside the generated block

Record actionable instructions

Edit connection settings

Check that the guide works

​Create or refresh the guide

​Keep manual notes outside the generated block

​Record actionable instructions

​Edit connection settings

​Check that the guide works

Create or refresh the guide

Keep manual notes outside the generated block

Record actionable instructions

Edit connection settings

Check that the guide works