lib search

arduino-cli lib search¶

Searches for one or more libraries matching a query.

Synopsis¶

Search for libraries matching zero or more search terms.

All searches are performed in a case-insensitive fashion. Queries containing multiple search terms will return only libraries that match all of the terms.

Search terms that do not match the QV syntax described below are basic search terms, and will match libraries that include the term anywhere in any of the following fields: - Author - Name - Paragraph - Provides - Sentence

A special syntax, called qualifier-value (QV), indicates that a search term should be compared against only one field of each library index entry. This syntax uses the name of an index field (case-insensitive), an equals sign (=) or a colon (:), and a value, e.g. 'name=ArduinoJson' or 'provides:tinyusb.h'.

QV search terms that use a colon separator will match all libraries with the value anywhere in the named field, and QV search terms that use an equals separator will match only libraries with exactly the provided value in the named field.

QV search terms can include embedded spaces using double-quote (") characters around the value or the entire term, e.g. 'category="Data Processing"' and '"category=Data Processing"' are equivalent. A QV term can include a literal double-quote character by preceding it with a backslash () character.

NOTE: QV search terms using double-quote or backslash characters that are passed as command-line arguments may require quoting or escaping to prevent the shell from interpreting those characters.

In addition to the fields listed above, QV terms can use these qualifiers: - Architectures - Category - Dependencies - License - Maintainer - Types - Version - Website

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

Examples¶

  arduino-cli lib search audio                               # basic search for "audio"
  arduino-cli lib search name:buzzer                         # libraries with "buzzer" in the Name field
  arduino-cli lib search name=pcf8523                        # libraries with a Name exactly matching "pcf8523"
  arduino-cli lib search "author:\"Daniel Garcia\""          # libraries authored by Daniel Garcia
  arduino-cli lib search author=Adafruit name:gfx            # libraries authored only by Adafruit with "gfx" in their Name
  arduino-cli lib search esp32 display maintainer=espressif  # basic search for "esp32" and "display" limited to official Maintainer
  arduino-cli lib search dependencies:IRremote               # libraries that depend on at least "IRremote"
  arduino-cli lib search dependencies=IRremote               # libraries that depend only on "IRremote"

Options¶

  -h, --help                    help for search
      --names                   Show library names only.
      --omit-releases-details   Omit library details far all versions except the latest (produce a more compact JSON output).

Options inherited from parent commands¶

      --additional-urls strings   Comma-separated list of additional URLs for the Boards Manager.
      --config-dir string         Sets the default data directory (Arduino CLI will look for configuration file in this directory).
      --config-file string        The custom config file (if not specified the default will be used).
      --json                      Print the output in JSON format.
      --log                       Print the logs on the standard output.
      --log-file string           Path to the file where logs will be written.
      --log-format string         The output format for the logs, can be: text, json (default "text")
      --log-level string          Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic (default "info")
      --no-color                  Disable colored output.