Arduino CLI

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

lib search

クエリに一致する 1 つ以上のライブラリを検索します。

概要

0個以上の検索語に一致するライブラリを検索します。

すべての検索は、大文字と小文字を区別しない方法で実行されます。複数の検索用語を含むクエリでは、すべての用語に一致するライブラリのみが返されます。

以下に説明する QV構文に一致しない検索語は基本的な検索語であり、次のいずれかのフィールドにその用語が含まれるライブラリと一致します: - Author - Name - Paragraph - Provides - Sentence

修飾子値(​​QV)と呼ばれる特別な構文は、検索語を各ライブラリインデックスエントリの1つのフィールドのみと比較する必要があることを示します。 この構文では、インデックスフィールドの名前(大文字と小文字は区別されません), 等号(=)またはコロン(:)および値(例: ‘name=ArduinoJson’または’provides:tinyusb.h’)を使用します。

コロン区切り文字を使用する QV検索語は、指定されたフィールド内の任意の値を持つすべてのライブラリと一致し、等号区切り文字を使用する QV検索語は、指定されたフィールドに指定された値と正確に一致するライブラリのみと一致します。

QV検索語には、値または用語全体を二重引用符(")文字で囲んだ埋め込みスペースを含めることができます。 たとえば、'category=“Data Processing”'と’category=Data Processing’は同等です。QV語には、リテラルの二重引用符を使用するには、前にバックスラッシュ (\) 文字を付けます。

注: コマンドライン引数として渡される二重引用符またはバックスラッシュ文字を使用する QV検索語では、シェルがこれらの文字を解釈できないようにするために引用符またはエスケープが必要になる場合があります。

上記のフィールドに加えて、QV検索語では次の修飾子を使用できます: - Architectures - Category - Dependencies - License - Maintainer - Types - Version - Website

$ arduino-cli lib search [SEARCH_TERM ...] [flags]

例

$ arduino-cli lib search audio                               # "audio"の基本的な検索
$ arduino-cli lib search name:buzzer                         # 名前フィールドに"buzzer"が含まれるライブラリ
$ arduino-cli lib search name=pcf8523                        # "pcf8523"と完全に一致する名前を持つライブラリ
$ arduino-cli lib search "author:\"Daniel Garcia\""          # "Daniel Garcia"著のライブラリ
$ arduino-cli lib search author=Adafruit name:gfx            # 名前に"gfx"が含まれる Adafruit によってのみ作成されたライブラリ
$ arduino-cli lib search esp32 display maintainer=espressif  # 公式メンテナ限定の"esp32" "display"の基本的な検索
$ arduino-cli lib search dependencies:IRremote               # 少なくとも"IRremote"に依存するライブラリ
$ arduino-cli lib search dependencies=IRremote               # "IRremote"のみに依存するライブラリ

オプション

-h, --help                    searchのヘルプ
    --names                   ライブラリ名のみを表示します
    --omit-releases-details   最新を除くすべてのバージョンのライブラリの詳細を省略します(よりコンパクトなJSON 出力を生成します)

親コマンドから継承されたオプション

    --additional-urls strings   ボードマネージャーの追加URLのカンマ区切りリスト
    --config-file string        カスタム構成ファイル (指定しない場合はデフォルトが使用されます)
    --format string             ログの出力形式は次のとおりです: text, json, jsonmini, yaml(デフォルトは"text")
    --log                       ログを標準出力に出力します
    --log-file string           ログが書き込まれるファイルへのパス
    --log-format string         ログの出力形式は text, json です。
    --log-level string          このレベル以上のメッセージがログに記録されます。 有効なレベルは次のとおりです: trace, debug, info, warn, error, fatal, panic
    --no-color                  カラー出力を無効にします。

関連項目