• Documentation
  • PlatformIO
  • v6.0.0
PlatformIO
v6.0.0
  • What is PlatformIO?

Getting Started

  • PlatformIO IDE
  • PlatformIO Core (CLI)
    • Installation
    • Quick Start
    • CLI Guide
      • Usage
      • Options
      • Commands
        • pio access
        • pio account
        • pio boards
        • pio check
        • pio ci
        • pio debug
        • pio device
        • pio home
        • pio lib
        • pio org
        • pio pkg
        • pio platform
        • pio project
        • pio remote
        • pio run
        • pio settings
        • pio system
        • pio team
        • pio test
        • pio update
        • pio upgrade
  • PlatformIO Home
  • PlatformIO Account
  • Tutorials and Examples

Configuration

  • platformio.ini
  • Build Configurations
  • Environment variables

Instruments

  • Library Management
  • Platforms
  • Frameworks
  • Boards
  • Custom Platform & Board

Advanced

  • Scripting
  • Debugging
  • Unit Testing
  • Static Code Analysis
  • Remote Development

Integration

  • Cloud & Desktop IDE
  • Continuous Integration
  • Compilation database compile_commands.json

Miscellaneous

  • FAQ
  • Migrating from 5.x to 6.0

pio pkg search¶

New in version 6.0.

Contents

  • pio pkg search

    • Usage

    • Description

    • Options

    • Search Qualifiers

      • Search by type or tier

      • Search by metadata

      • Search by ownership or contribution

      • Filter by compatibility

      • Search by library header

      • Filter by dependencies

    • Search Operators

    • Examples

    • See Also

Usage¶

pio pkg search [OPTIONS] [QUERY]

Description¶

Search the PlatformIO Registry for packages matching the search query. You can use Search Qualifiers or perform a full-text search over the following package metadata:

  • Name

  • Description

  • Authors

  • Keywords

  • README file

  • Development platform boards.

Multiple Search Qualifiers and full-text search words are allowed if split with space. See also Search Operators for the advanced search.

Options¶

-p, --page¶

Number of items to skip before starting to collect the result set.

-s, --sort¶

Sort method. Available methods are relevance, popularity, trending, added, and updated.

Search Qualifiers¶

You can search for packages on the PlatformIO Registry and narrow the results using these search qualifiers in any combination.

Search by type or tier¶

You can search packages by type (see Package Types) or tier qualifier.

Qualifier

Example

type:NAME

type:library matches only library packages

tier:NAME

  • tier:official matches high-quality official packages owned and maintained by PlatformIO Labs

  • tier:verified matches verified packages owned and maintained by third-party technology partners

  • tier:community matches community packages.

Search by metadata¶

Search for packages by their metadata.

Qualifier

Example

name:NAME

name:”Adafruit BusIO” matches Adafruit BusIO library

keyword:NAME

keyword:json matches packages by “json” keyword

category:NAME

category:”AI & ML” matches AI and ML compatible packages

Search by ownership or contribution¶

Search for packages owned by the owner or maintained by the author.

Qualifier

Example

owner:NAME

owner:espressif matches packages owned by Espressif Systems

author:NAME

author:”Paul Stoffregen” matches packages with Paul Stoffregen’s contribution

Filter by compatibility¶

You can filter packages by compatibility using framework or platform qualifier.

Qualifier

Example

framework:NAME

framework:arduino json matches JSON related packages compatible with Arduino framework

platform:NAME

platform:espressif32 matches packages compatible with Espressif32 development platform

Search by library header¶

You can search for libraries that contain header file.

Qualifier

Example

header:FILENAME

header:”Adafruit_Sensor.h” matches packages that contain Adafruit_Sensor.h header/include file.

Filter by dependencies¶

You can search for packages that depend on the specified package or for package dependencies.

Qualifier

Example

dependent:OWNER/NAME

dependent:”bblanchon/ArduinoJson” matches packages that depend on ArduinoJson library

dependency:OWNER/NAME

dependency:”painlessmesh/painlessMesh” matches painlessMesh dependencies

Search Operators¶

PlatformIO Registry supports the following operators:

Operator

Description

Example

+

A leading or trailing plus sign indicates that this word must be present in the search result that is returned.

json +arduino matches JSON-related packages that contain the “arduino” word in the package metadata

-

A leading or trailing minus sign indicates that this word must not be present in the search result that is returned.

json -mbed matches JSON-related packages that do not contain the “mbed” word in the package metadata

*

The asterisk serves as the truncation (or wildcard) operator. Unlike the other operators, it is appended to the word to be affected. Words match if they begin with the word preceding the * operator.

DHT* matches packages that contain a word that starts with “DHT”

"

A phrase that is enclosed within double quote (") characters matches only packages that contain the phrase literally, as it was typed.

“humidity sensor” matches packages that contain the “humidity sensor” phrase.

Examples¶

  1. List trending libraries

> pio pkg search "type:library" --sort trending

Found 12374 packages (page 1 of 1238)

adafruit/Adafruit Unified Sensor
Library • 1.1.5 • Published on Mon Mar  7 21:09:03 2022
Required for all Adafruit Unified Sensor based libraries. A unified sensor abstraction layer used by many Adafruit sensor libraries.

stm32duino/STM32duino FreeRTOS
Library • 10.3.1 • Published on Mon Feb 28 15:46:45 2022
Real Time Operating System implemented for STM32
...
  1. List trending libraries

> pio pkg search "type:library" --sort trending

Found 12374 packages (page 1 of 1238)

adafruit/Adafruit Unified Sensor
Library • 1.1.5 • Published on Mon Mar  7 21:09:03 2022
Required for all Adafruit Unified Sensor based libraries. A unified sensor abstraction layer used by many Adafruit sensor libraries.

stm32duino/STM32duino FreeRTOS
Library • 10.3.1 • Published on Mon Feb 28 15:46:45 2022
Real Time Operating System implemented for STM32
...
  1. Search for packages that match words that start with “DHT”

> pio pkg search "DHT*"

Found 163 packages (page 1 of 17)

0nism/ESP32-DHT11
Library • 1.0.1 • Published on Tue Oct 16 19:30:42 2018
Full featured driver to use DHT11 sensor on esp32 with esp-idf

adafruit/Adafruit DHT Unified
Library • 1.0.0 • Published on Fri May 27 20:45:19 2016
Unified sensor library version of the DHT humidity ...

robtillaart/DHT20
Library • 0.1.0 • Published on Tue Jan 11 20:35:46 2022
Arduino library for I2C DHT20 temperature and humidity sensor.
...
  1. Search for packages that support STM32F405RG MCU

> pio pkg search "STM32F405RG"

Found 4 packages (page 1 of 1)

aceinna/aceinna_imu
Official Platform • 1.3.8 • Published on Mon Oct 25 16:39:27 2021
Open-source, embedded development ...

twilio/Breakout Arduino Library
Library • 0.1.0 • Published on Tue Oct 23 16:22:19 2018
Arduino library for the Twilio ...

platformio/ststm32
Platform • 15.2.0 • Published on Fri Jan 28 13:21:03 2022
The STM32 family of 32-bit Flash MCUs ...

platformio/framework-arduinoststm32
Tool • 4.20200.220204 • Published on Mon Feb  7 09:47:31 2022
Arduino Wiring-based Framework for ST STM32 microcontrollers
  1. Search for official development platforms that support STM32F405RG MCU

> pio pkg search "type:platform tier:official STM32F405RG"

Found 1 packages (page 1 of 1)

aceinna/aceinna_imu
Official Platform • 1.3.8 • Published on Mon Oct 25 16:39:27 2021
Open-source, embedded development platform for Aceinna IMU hardware. Run custom algorithms and navigation code on Aceinna IMU/INS hardware.

See Also¶

  • pio pkg show

  • pio pkg list

  • pio pkg install