設定
Author:ArduinoV1.5.1

設定キー

  • board_manager
    • additional_urls: 使用するボードプラットフォーム向けの追加のボードマネージャーパッケージのインデックスファイルを示すURL。
  • daemon: Arduino CLIをgRPCサーバーとして実行するときに関連するオプション
    • port: gRPCクライアントが接続するのに利用するTCPポート
  • directories: Arduino CLIが使うディレクトリ
    • data: ボード・ライブラリマネージャ―のインデックスファイルの格納とボードマネージャープラットフォームのインストールに利用するディレクトリ。
    • downloads: ボード・ライブラリマネージャ―のインストール時に、ダウンロードしたファイルを格納するのに利用するディレクトリ。
    • user: Arduino IDEのスケッチブックと同等。ライブラリマネージャ―のインストールは、ユーザーディレクトリのlibrariesサブディレクトリに対して行われます。ユーザーは、サードパーティプラットフォームを、ユーザーディレクトリのhardwareディレクトリに手動でインストールすることができます。
    • builtin.libraries: このディレクトリ内のライブラリは、ユーザーがインストールすることなく、すべてのプラットフォームで利用可能です。しかし、同一の名前を持つ他のインストールされたライブラリの中で優先度は最低です。Arduino IDEに同梱のライブラリディレクトリと同等です。
  • library: Arduinoライブラリに関係する設定オプション。
    • enable_unsafe_install: trueに設定すると、arduino-cli lib installの--git-urlと--zip-fileの使用を許可します。ライブ ラリマネージャ―の提出プロセスを経ていないファイルのインストールを許可するので、これらは「安全ではない」インストール方法と考えられています。
  • locale: Arduino CLIがユーザーとやり取りをする際の言語。パラメータは、標準のPOSIXフォーマットの言語識別子、<language>[_<TERRITORY>[.<encoding>]]です。例えば、itやit_ITやit_IT.UTF-8。
  • logging: Arduino CLIのログの設定オプション。
    • file: ログを記録するファイルパス。
    • format: ログの出力フォーマット。textかjson。
    • level: このレベル以上のメッセージが記録されます。有効な値は、traceとdebug、info、warn、error、fatal、panicです。
  • metrics: Arduino CLIの継続的な改善に利用されるデータ収集に関連する設定。
    • addr: メトリクスの通信に利用するTCPポート。
    • enabled: メトリクスの利用を制御します。
  • output: 文字の出力に関する設定。
    • no_color: デフォルトでは出力にANSIカラーエスケープコードが付与されます。trueに設定すれば、テキストのカラー出力を抑止します。
  • sketch: スケッチの仕様に関連する設定オプション。
    • always_export_binaries: trueに設定すると、arduino-cli compileが常にバイナリをスケッチフォルダに保存します。これは、--export-binariesフラグを利用するのと同等です。
  • updater: Arduino CLIの更新に関する設定オプション。
    • enable_notification: falseに設定すると、新しいArduino CLIのリリースの通知を抑止します。デフォルトはtrue。
  • build_cache: コンパイル時のキャッシュに関する設定オプション。
    • path: ビルド時のキャッシュのパス。デフォルトは$TMP/arduino
    • extra_path: build_cache.pathに見つからない場合に、事前コンパイルされたファイルを検索するパスのリスト。
    • compilations_before_purge: キャッシュを削除する間隔を、コンパイル回数で表します。デフォルトは10です。0の場合はキャッシュは削除されません。
    • ttl: ビルドフォルダのキャッシュの有効期間。コンパイルによりキャッシュがヒットすると、関連するビルドファイルの生存期間が更新されます。値のフォーマットは、time.ParseDuration()の有効な入力となる必要があります。デフォルトは720h(30日)。
  • network: ネットワーク接続に関する設定オプション。
    • proxy: プロキシサーバーのURL。
    • connection_timeout: ネットワーク接続のタイムアウト。値のフォーマットは、time.ParseDuration()の有効な入力となる必要があります。デフォルトは60s(60秒)。0は無限に待つことを意味します。
    • cloud_api.skip_board_detection_calls: trueに設定すると、Arduino CLIは、不明なボードを検出するのに、Arduino Cloud APIに対するネットワーク呼び出しを行いません。

デフォルトディレクトリ

以下は、設定ファイルで代替のディレクトリが指定されていない場合に、Arduino CLIが選択するデフォルトのディレクトリです。

  • directories.dataのデフォルトは、OS依存です。
    • Linux(と他のUNIXベースOS): {HOME}/.arduino15
    • Windows: {HOME}/AppData/Local/Arduino15
    • macOS: {HOME}/Library/Arduino15
  • directories.downloadのデフォルトは、{directories.data}/stagingです。{directories.data}の値が設定で変更されていれば、ユーザーが指定した値が利用されます。
  • directories.userのデフォルトは、OS依存です。
    • Linux(と他のUNIXベースOS): {HOME}/Arduino
    • Windows: {DOCUMENTS}/Arduino
    • macOS: {HOME}/Documents/Arduino

設定方法

Arduino CLIの設定方法には3種類あります。

  • コマンドラインフラグ
  • 環境変数
  • 設定ファイル

設定オプションが複数の方法で指定された場合、上記で上にある方法で指定された値が下の値を上書きします。

設定オプションが指定されない場合は、Arduino CLIはデフォルト値を利用します。

arduino-cli config dumpで、現在の設定値を表示します。

コマンドラインフラグ

Arduino CLIのコマンドラインフラグは、コマンドラインのヘルプとArduino CLIコマンドリファレンスで説明されています。

例

`–additional-urls~コマンドラインフラグを使い、追加のボードマネージャーのURLを設定します。

1

$ arduino-cli core update-index --additional-urls https://downloads.arduino.cc/packages/package_staging_index.json

環境変数

すべての設定オプションは、環境変数で設定できます。変数名は、ARDUINOで始まり、設定のキー名が続きます。それぞれの部分は_で区切ります。例えば、環境変数ARDUINO_DIRECTORIES_USERは、directories.user設定オプションを設定します。

LinuxとmacOSでは、exportコマンドを使い、環境変数を設定します。Windowsでは、setコマンドを使います。

環境変数ARDUINO_BOARD_MANAGER_ADDITIONAL_URLSは、空白で区切ったURLのリストで指定することもできます。

例

環境変数ARDUINO_BOARD_MANAGER_ADDITIONAL_URLSを使い、追加のボードマネージャーのURLを設定します。

1

$ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS=https://downloads.arduino.cc/packages/package_staging_index.json

環境変数ARDUINO_BOARD_MANAGER_ADDITIONAL_URLSを使い、複数の追加のボードマネージャーのURLを設定します。

1

$ export ARDUINO_BOARD_MANAGER_ADDITIONAL_URLS="https://downloads.arduino.cc/packages/package_staging_index.json https://downloads.arduino.cc/packages/package_mbed_index.json"

設定ファイル

arduino-cli config initで、新規の空の設定ファイルを作成します。

これは、コマンドラインフラグや環境変数で設定したオプションを保存することもできます。例えば、

1

arduino-cli config init --additional-urls https://downloads.arduino.cc/packages/package_staging_index.json

位置

デフォルトの設定ファイルの名前は、arduino-cli.yamlです。設定ファイルは、以下に示す場所を順に検索します。

  1. コマンドラインフラグ--config-fileで指定した場所
  2. 環境変数ARDUINO_CONFIG_FILEで指定した場所
  3. 環境変数ARDUINO_DIRECTORIES_DATAで指定した場所

複数の設定ファイルが存在する場合は、上記のリストの上にある方が利用されます。設定ファイルは結合されません。

利用する設定ファイルは、以下のコマンドを実行すればわかります。

1

arduino-cli config dump --verbose

例

YAMLフォーマットの設定ファイルを使って追加のボードマネージャーのURLを設定します。

1
2
3

board_manager:
  additional_urls:
    - https://downloads.arduino.cc/packages/package_staging_index.json

同じことをTOMLファイルで行います。

1
2

[board_manager]
additional_urls = [ "https://downloads.arduino.cc/packages/package_staging_index.json" ]

JSONスキーマ

設定ファイルのJSONスキーマは、ファイルの内容を独立に検証する野に利用されます。このバージョンでは、このスキーマは不安定です。

i
このページでは、最新版のArduino CLIを確認できます。過去のバージョンはこちらにあります。

オリジナルのページ

https://docs.arduino.cc/arduino-cli/configuration/

最終更新日

August 16, 2026

inserted by FC2 system