arduino-cliは、基本コマンドのコマンドライン補完(タブ補完としても知られています)をサポートしています。現状、bashとzsh、fish、powershellがサポートされています。
始める前に
補完を動作させるために必要なファイルを生成するには、まず、Arduino CLIをインストールする必要があります。
補完ファイルを生成する
補完ファイルを生成するには、arduino-cli completion [bash|zsh|fish|powershell] [--no-descriptions]を利用できます。デフォルトでは、このコマンドは補完ファイルの内容を標準出力(シェルウインドウ)に表示します。実際のファイルに保存するには、リダイレクト記号>を使います。
Bash
arduino-cli completion bash > arduino-cli.shを使い、補完ファイルを生成します。この時点で、そのファイルを、sudo mv arduino-cli.sh /etc/bash_completion.d/で、/etc/bash_completion.d/に移動できます(rootアクセスが必要です)。
推奨されていない方法としては、~/.bashrcで補完ファイルを読み込む方法があります。
この機能を試すには、新しいシェルを開く必要があります。
Zsh
補完ファイルを生成するには、arduino-cli completion zsh > _arduino-cliを利用できます。この時点で、補完ファイルを配置するディレクトリをすでに作成していれば、このファイルを、fpathに含まれるディレクトリに配置することができます。
あるいは、ディレクトリを作成して、そのディレクトリをfpathに追加し、ファイルをそこにコピーします。
mkdir ~/completion_zsh~/.zshrcファイルの先頭に、fpath=($HOME/completion_zsh $fpath)を追加します。- mv _arduino-cli ~/completion_zsh/
この機能を試すには、新しいシェルを開く必要があります。
Fish
補完ファイルを生成するには、arduino-cli completion fish > arduino-cli.fishを利用できます。この時点で、公式ドキュメント記載されているように、~/.config/fish/completionsに、ファイルを配置できます。ディレクトリがない場合は、ディレクトリを作成し、mkdir -p ~/.config/fish/completions/、補完ファイルを移動しますmv arduino-cli.fish ~/.config/fish/completions/。
この機能を試すには、新しいシェルを開く必要があります。
Powershell
一時的な補完ファイルを生成するには、arduino-cli completion powershell > arduino-cli.ps1を利用できます。この時点で、生成したファイルの内容を、Powershellのプロファイルファイルに追加する必要があります。
Get-Content -Path arduino-cli.ps1 | Add-Content -Path $profileもしくは、好みのテキストエディタを使い手で追加します。- ひとつ前のコマンドは、2つの
using namespaceという行を追加します。それらを、$profileファイルの先頭に移動します。 - まだ実施していない場合は、
Set-PSReadlineKeyHandler -Key Tab -Function MenuCompleteという行を$profileに追加します。PowerShellでタブ補完を有効にするために必要です。
この機能を試すには、新しいシェルを開く必要があります。
PowerShellのタブ補完についての詳細情報は、Autocomplete in PowerShellを参照してください。
コマンドとフラグの説明を無効にする
デフォルトでは、fishとzsh、bashでは、コマンドとフラグの説明が有効になっています。この動作を無効化したい場合、--no-descriptionsフラグを、completionコマンドを呼ぶ際に与えると、生成されたファイルには説明が含まれません。
注意: このフラグはpowershellでは使えません。
Brew
公式ドキュメントに従い、homebrewパッケージマネージャーを使い、arduino-cliをインストールすれば、追加作業無しで補完が利用できます。
オリジナルのページ
https://docs.arduino.cc/arduino-cli/command-line-completion/
最終更新日
August 1, 2026