Arduino CLI

2023年12月21日
 
2024年1月12日

コマンドライン補完

arduino-cliの基本的なコマンドのコマンドライン補完(タブ補完とも呼ばれます)をサポートします。 現在bash, zsh, fish およびpowershell がサポートされています。

始める前に

補完を機能させるために必要なファイルを生成するには、まずArduino CLIをインストールする必要があります。

補完ファイルを生成する

完了ファイルを生成するには、 arduino-cli completion [bash|zsh|fish|powershell] [--no-descriptions] が使用できます。 デフォルトでは、このコマンドは完了ファイルの内容を標準出力(shell window)に出力します。 実際のファイルに保存するには、>(リダイレクト記号)を使用します。

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 に追加し、その中にファイルをコピーすることもできます。

  1. mkdir ~/completion_zsh
  2. ~/.zshrc ファイルの先頭にfpath=($HOME/completion_zsh $fpath)を追加します
  3. 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 プロファイルファイルに追加する必要があります。

  1. Get-Content -Path arduino-cli.ps1 | Add-Content -Path $profileまたは、お気に入りのテキストエディタを使用して手動で追加します。
  2. 前のコマンドでは 2つの using namespace行が追加され、$profileファイルの先頭に移動されました。
  3. まだ行っていない場合は、次の行Set-PSReadlineKeyHandler -Key Tab -Function MenuCompleteを$profileファイルに追加します。これは、PowerShell で TAB 補完を有効にするために必要です。
  4. 一時ファイルを削除しますdel arduino-cli.ps1。

機能をテストするには、必ず新しいシェルを開いてください。

PowerShell のタブコンプリートの詳細については、 PowerShell のオートコンプリートを参照してください。

コマンドとフラグの説明を無効にする

デフォルトでは、fish, zsh, および bash 補完のコマンドとフラグの説明がデフォルトで有効になっています。この動作を無効にしたい場合は、completionコマンドを呼び出すときに--no-descriptionsフラグを渡すだけでよく、生成されるファイルには説明がありません。

注意:このフラグは PowerShell と互換性がありません

Brew

homebrewパッケージ マネージャーを使用してarduino-cliをインストールする場合、公式ドキュメントに従っていれば、すぐに補完が機能するはずです。