CLIリファレンス

embedrの全コマンドとオプション。プロジェクト、ボード、ビルド、書き込み、モニター、ライブラリ、PCB、エージェント。

embedrコマンドは、デスクトップアプリのCompile、Flash、ライブラリ機能を支えるファームウェアのツールチェーンです。アプリに同梱されており、エディタのTerminalタブではembedr(とハードウェアツールのpcb)にすでにパスが通っています。ターミナルとセットアップを参照してください。

プロジェクトを扱うコマンドはすべて、現在のフォルダでembedr.yamlを探します。別のプロジェクトを扱うには--path <folder>を渡します。

グローバルオプション

embedr --version
embedr --format json <command> ...
embedr -f json <command> ...
オプション 意味
--version CLIのバージョンを表示します。
--format、-f text|json 出力形式。既定はtext。コマンド名の前に置きます。

スクリプトやCIでは--format jsonを使ってください。一部のコマンドのあとでは-fは別の意味になることに注意してください(boards -fは絞り込み、init -fはフレームワークの指定、devices -fは絞り込み)。

コマンド一覧

コマンド 用途
embedr init プロジェクトを作成します。
embedr boards ボードのプリセットを一覧表示します。
embedr compile ファームウェアをビルドします。
embedr upload ファームウェアをデバイスに書き込みます。
embedr run ビルドと書き込みを行い、必要ならそのままモニターします。
embedr monitor シリアルモニター。
embedr devices 接続中のシリアルデバイスを一覧表示します。
embedr debug デバッグサーバーまたはGDBを起動します。
embedr clean ビルド出力を削除します。
embedr validate プロジェクトの構成と部品を確認します。
embedr lib ... PlatformIOのライブラリ。
embedr target-config、set-target-config、select-target ターゲット設定を読み取り、保存します。
embedr manifest inspect、manifest discover embedr.yamlの実行時メタデータを確認します。
embedr pcb ... プロジェクトのpcb/ハードウェアワークスペース。
embedr search、add、remove、list embedr.yaml内のハードウェア部品の参照。
embedr agent デスクトップアプリのエージェントをターミナルから実行します。

プロジェクトを作成する

embedr init                          # initialise the current folder (Arduino Uno)
embedr init --name my-project        # current folder, explicit project name
embedr init my-project               # new folder ./my-project
embedr init my-project -b esp32      # ESP32, Arduino framework
embedr init my-project -b esp32-idf  # ESP32, ESP-IDF
embedr init my-project -b pico       # Raspberry Pi Pico
オプション 意味
NAME(引数) この名前で新しいフォルダを作成します。省略すると現在のフォルダを初期化します。
--name 現在のフォルダ(または--path)を初期化するときのプロジェクト名。NAMEとは併用できません。
--board、-b ボードのプリセット。既定はuno。一覧はembedr boardsで確認します。
--platform、-p PlatformIOのプラットフォーム。プリセットを上書きします。
--framework、-f フレームワークの上書き(arduino、espidf、stm32cubeなど)。
--description、-d プロジェクトの説明。
--path 名前付きプロジェクトの親フォルダ、またはNAMEを省略した場合はプロジェクトフォルダ。

次のものが作成されます。

my-project/
├── embedr.yaml
├── platformio.ini
├── src/
│   └── main.cpp      # or main.c, depending on the framework
├── lib/
└── .gitignore

不明なボードのプリセットを指定すると失敗し、似たプリセットが提案されます。すでにembedr.yamlのあるフォルダの初期化や、すでに存在するフォルダの作成も失敗します。

ボード

embedr boards
embedr boards --all
embedr boards --filter esp32
embedr boards --category stm32
embedr boards --limit 20
embedr boards --sync
オプション 意味
--filter、-f 名前、プラットフォーム、カテゴリで絞り込みます。
--all、-a 人気のボードだけでなく、すべてのボードを表示します。
--category、-c esp、arduino、stm32、rp2040、teensy、nordic、samdのいずれか。
--limit、-l 表示するボードの最大数。
--sync、-s リモートのレジストリからボードのインデックスを更新します。

ビルド

embedr compile
embedr compile -e esp32dev
embedr compile --clean
embedr compile --verbose
embedr compile --monitor-speed 115200 --upload-speed 921600
オプション 意味
--environment、-e platformio.iniの環境。
--clean、-c ビルド前にクリーンします。
--verbose、-v 詳細なビルド出力。
--upload-protocol 書き込みプロトコルの上書き。
--upload-speed 書き込み速度の上書き。
--monitor-speed シリアルモニターの速度の上書き。
--debug-tool デバッグツールの上書き。
--path プロジェクトフォルダ。

manifest_version: 1のプロジェクトでは、4つの上書きオプションはその場限りではなく、プロジェクトに保存されます。

環境の最初のビルドではツールチェーンをダウンロードするため、最大20分かかることがあります。以降のビルドの制限は10分です。時間切れになったビルドは、出力の最後の部分とともにBuild timed out after …と報告します。

書き込みと実行

embedr upload                       # auto-detect the port
embedr upload -p /dev/cu.usbserial-0001
embedr upload -p COM3
embedr upload --select              # choose interactively when several boards are connected

embedr run                          # build and upload
embedr run -m                       # build, upload, then open the serial monitor
embedr run -p /dev/ttyUSB0

uploadのオプション:

オプション 意味
--port、-p シリアルポート。省略すると自動検出します。
--select、-s 複数が接続されているとき、デバイスを対話的に選びます。
--environment、-e 環境。
--verbose、-v 詳細な出力。
--upload-protocol、--upload-speed、--monitor-speed、--debug-tool compileと同じです。
--path プロジェクトフォルダ。

runのオプション: --port/-p、--environment/-e、--verbose/-v、--monitor/-m(書き込み後にシリアルモニターを開く)、--path。

モニターとデバイス

embedr devices
embedr devices -f USB
embedr devices -f "Silicon Labs"
embedr devices --watch
embedr --format json devices

embedr monitor
embedr monitor -p /dev/ttyUSB0 -b 9600
devicesのオプション 意味
--filter、-f 名前、ポート、ベンダー(USB、ttyACM、Silicon Labs)で絞り込みます。
--watch、-w デバイスの接続や取り外しを監視し続けます。Ctrl+Cで停止します。
monitorのオプション 意味
--port、-p シリアルポート。省略すると自動検出します。
--baud、-b ボーレート。既定はプロジェクトのモニター速度です。
--environment、-e 環境。
--path プロジェクトフォルダ。

Ctrl+Cでモニターを終了します。

デバッグ

embedr debug              # debug server on port 3333
embedr debug -i gdb       # interactive GDB
embedr debug -p 4444      # custom server port
オプション 意味
--interface、-i server|gdb デバッグサーバー(既定)または対話的なGDBセッションを起動します。
--port、-p デバッグサーバーのポート。既定は3333。
--environment、-e 環境。
--path プロジェクトフォルダ。

デバッグプローブ(ESP-Prog、J-Link、ST-Linkなど)と、デバッグシンボル付きのビルドが必要です。

クリーンと検証

embedr clean
embedr validate

cleanはビルド出力を削除します。validateはプロジェクトの構成と部品の参照を確認します。どちらも--pathを受け付けます。

ライブラリ

embedr lib search "neopixel"
embedr lib search dht --limit 5
embedr lib install "Adafruit NeoPixel"
embedr lib install "DHT sensor library" --version 1.4.4
embedr lib list
embedr lib uninstall FastLED
embedr lib update
コマンド オプション 動作
lib search QUERY --limit、-l(既定は20) PlatformIOのレジストリを検索します。
lib install LIBRARY --version、-v; --path インストールし、プロジェクトで宣言したライブラリに追加します。
lib list --path 宣言済みとインストール済みのライブラリを表示します。
lib uninstall LIBRARY --path 宣言の一覧から削除し、アンインストールします。
lib update --path すべてのライブラリを更新します。

一覧の保存場所は依存関係とライブラリを参照してください。

ターゲット設定

embedr target-config
embedr target-config --target esp32 -e esp32dev
embedr set-target-config --monitor-speed 115200 --upload-speed 921600
embedr set-target-config --reset-defaults
embedr select-target --target esp32-s3
コマンド 動作
target-config 対応しているターゲット設定(書き込みプロトコルと速度、モニター速度、デバッグツール)と現在の値を表示します。
set-target-config 設定をプロジェクトに保存します。--reset-defaultsは、渡した設定を適用する前に、対応するすべての設定をリセットします。
select-target プロジェクトをボードのプリセットに切り替え、対応するembedr.yamlとplatformio.iniの状態を保存します。--targetは必須です。

共通のオプション: --target、--environment/-e、--path。set-target-configとselect-targetは--upload-protocol、--upload-speed、--monitor-speed、--debug-toolも受け付けます。select-targetは、embedr.yamlに固定のターゲットIDを保存するための--manifest-target-idを受け付けます。

ツールバーのターゲット選択も同じ設定を使います。ターゲットと環境を参照してください。

マニフェスト

embedr manifest inspect
embedr manifest inspect -e esp32dev
embedr manifest discover
embedr manifest discover --write
コマンド オプション 動作
manifest inspect --environment/-e、--path 1つの環境について、Embedrが解決したプロジェクトのマニフェストを表示します。
manifest discover --write、--path 既存のプロジェクト(Zephyrのwest.yml/prj.conf、CMake、Makefile、Cargo、package.json、src/、include/)を調べ、ビルド方法を提案します。--writeは提案をembedr.yamlに保存します。

プロジェクトマニフェストを参照してください。

PCBワークスペース

これらのコマンドは、プロジェクトのpcb/フォルダを扱います。

embedr pcb init
embedr pcb status
embedr pcb build
embedr pcb test
embedr pcb layout
embedr pcb layout --check
embedr pcb layout --no-open
embedr pcb layout --sync-footprints
embedr pcb open
embedr pcb fmt
コマンド 動作
pcb init pcb/ワークスペースを作成します。作成したファイルと、すでに存在していたファイルを報告します。
pcb status ハードウェアのツールチェーン、ワークスペース、メインの基板を表示します。
pcb build Zenerソースをビルドします。
pcb test ソースのチェックを実行します。
pcb layout KiCadの基板を生成または更新します。--checkはチェックのみを行い、--no-openは完了後にKiCadを開かず、--sync-footprintsは配置と配線を保ったままソースからフットプリントを再読み込みします。
pcb open 基板をKiCadで開きます。
pcb fmt Zenerソースを整形します。

すべて--pathを受け付けます。initとstatus以外は、ソースファイルを選ぶ--file <file.zen>も受け付けます。initとstatus以外は、先にembedr pcb initが必要です。

アプリとエージェントには、さらに多くのハードウェア操作(配置、配線、チェック、エクスポート、シミュレーション)があります。回路図とPCBと配置と配線を参照してください。

部品

これらは、ファームウェアのライブラリではなく、embedr.yaml内のハードウェア部品の参照を管理します。

embedr search led
embedr search --category Sensors
embedr search -r
embedr add led-5mm
embedr add led-5mm --instance status_led
embedr remove led-5mm --instance status_led
embedr list
コマンド オプション
search [QUERY] --category/-c、--limit/-l(既定は20)、--rebuild-index/-r。クエリを省略するとすべてを一覧表示します。
add COMPONENT_ID --instance/-i(同じ部品を複数使う場合)、--path
remove COMPONENT_ID --instance/-i、--path
list 現在のプロジェクトの部品を一覧表示します。

シンボル、フットプリント、データシートを備えた検索可能な部品ライブラリについては、コンポーネントライブラリを参照してください。

デスクトップのエージェント

embedr agentは、デスクトップアプリで動くのと同じエージェントに依頼を送ります。サインイン中のアカウント、モデル、承認、チャット履歴を使います。デスクトップアプリが起動してサインインしている必要があり、そうでなければEmbedr Desktop is not available. Open the desktop app, sign in, and retry.で失敗します。

embedr agent "build the firmware and fix any errors"   # one request
embedr agent                                           # interactive: type requests at the embedr> prompt
embedr agent --plan "plan a migration to the new sensor"
embedr agent --resume <thread-id>                      # continue a desktop chat thread
embedr agent --json "inspect the project"
オプション 意味
PROMPT(引数) 1つの依頼。省略すると対話セッションになります(対話的なターミナルが必要です)。
--project プロジェクトフォルダ。既定は現在のフォルダです。
--resume IDを指定して既存のチャットスレッドを続けます。指定しない場合、セッションごとに新しいスレッドが始まります。
--model 使うモデル。既定はgpt-6.2-sol。
--context-window わかっている場合、モデルのコンテキストサイズ(トークン数)。
--plan 読み取り専用のプランモードを使います。
--json イベントをJSON Linesで出力します。
--yes このセッションのすべてのツール要求を承認します。管理された環境でのみ使ってください。
--verbose-tools ツールの完全な結果を標準エラー出力に表示します。

--yesを付けない場合、ツールの承認はターミナルで確認されます。非対話のセッションでは拒否されます。1回限りの依頼がエラーで終わった場合、終了ステータス1で終了します。Ctrl+Dで対話プロンプトを終了します。

スクリプトでの利用

スクリプトがアプリのツールバーの状態に依存しないよう、すべてを明示的に渡してください。

embedr --format json validate --path ./robot
embedr --format json compile --path ./robot -e esp32dev
embedr --format json upload --path ./robot -e esp32dev -p /dev/ttyUSB0