Common Workflows
Step-by-step guides for hardware development, firmware debugging, and everyday tasks with Embedder CLI.
Start a new project
Set up your project
-
Create or select a project
Choose an existing project or create a new one.
-
Select your chip/board
Choose your microcontroller or development board. Embedder loads relevant documentation automatically.
-
Add peripherals
Select peripherals you’re using (I2C sensors, SPI displays, UART modules, etc.). You can also add custom peripherals and upload their datasheets.
-
Generate EMBEDDER.md
Creates an
EMBEDDER.md file with your project context, pin mappings, and configuration. This file is updated throughout your project.
Tips:
- Upload datasheets via the web console (
/console) before starting for best results
- The AI understands your hardware context from the uploaded documentation
- Update
EMBEDDER.md as your project evolves
Hardware interaction
Use the serial monitor
The serial terminal is integrated directly into Embedder. The AI reads serial output automatically.
Open the serial sidebar:
Or use the keyboard shortcut: `Ctrl+“ (backtick)
Auto-connect behavior:
- By default, Embedder auto-connects to your device after flashing
- To disable auto-connect, update your
EMBEDDER.md or prompt:
Add or modify peripherals at any time:
Example prompts:
Firmware development
Write peripheral drivers
Embedder has context from your datasheets and documentation.
Build and flash
Embedder knows the required toolchains and dependencies from the project catalogue. Ask for help getting started:
Work with HALs and SDKs
Embedder understands vendor-specific HALs and SDKs:
Debug with serial output
The AI reads serial output directly and can analyze issues in real-time.
Analyze errors
Share screenshots
Drag and drop images or paste with Ctrl+V:
Trace execution
Plan mode vs Act mode
Embedder has two modes for different workflows.
Act mode (default)
Full tool access. Embedder can read, write, and execute.
Use for:
- Writing and modifying code
- Building and flashing firmware
- Making changes to your project
Plan mode
Read-only analysis. Embedder researches without making changes.
Use for:
- Exploring unfamiliar code
- Planning complex refactors
- Reviewing architecture before changes
- Analyzing datasheets
Toggle between modes:
- Keyboard:
Shift+Tab
- Commands:
/plan or /act
Start in plan mode:
Documentation and context
Leverage uploaded documentation
Upload datasheets and manuals via the web console (/console). The /console command lets you upload additional documentation to existing platforms and peripherals in your project. Embedder uses them automatically:
Hardware-aware assistance
Embedder understands your specific hardware:
Bash mode
Bypass the AI agent and execute terminal commands directly using the ! prefix.
This runs the command in your terminal without AI interpretation. Useful for quick commands when you don’t need AI assistance.
Serial send mode
Send messages directly to your MCU over serial using the ~ prefix.
This sends the text directly to your device’s serial console. Useful for:
- Sending AT commands
- Interacting with device CLI/REPL
- Manual debugging commands
Reference files and directories
Use @ to quickly include files or directories in your prompts.
Reference a file
Reference a directory
Multiple references
Session management
Switch teams and projects
Resume previous sessions
Or use keyboard shortcut for quick access to history.
Manage context
For long conversations:
Track tasks
View your current task list:
Quick reference
Tips for best results
- Upload documentation first - Add datasheets via the web console (
/console) before starting
- Use /init early - Generate
EMBEDDER.md to give the AI full project context
- Be specific about hardware - Mention exact part numbers and pin configurations
- Use plan mode for research - Explore codebases without accidental changes
- Keep EMBEDDER.md updated - Add notes about your project as it evolves
Last modified on March 20, 2026
