LinuxCommandLibrary

pio-lib

Manage PlatformIO project libraries

TLDR

List installed libraries

$ pio lib list
copy

List built-in libraries based on installed development platforms and their frameworks
$ pio lib builtin
copy

Search for existing libraries
$ pio lib search [keyword]
copy

Show details about a library
$ pio lib show [library]
copy

Install a library
$ pio lib install [library]
copy

Update installed libraries
$ pio lib update
copy

Uninstall a library
$ pio lib uninstall [library]
copy

Show PlatformIO library registry statistics
$ pio lib stats
copy

SYNOPSIS

pio lib [arguments]

PARAMETERS

install
    Install a library. Arguments can be a library ID, library name, or path to a library.

uninstall
    Uninstall a library by ID or name.

update
    Update installed libraries to the latest versions.

search
    Search for libraries in the PlatformIO Registry.

list
    List installed libraries.

show
    Show detailed information about a library by ID or name.

--global
    Install or uninstall a library globally (system-wide).

-g
    Shorthand for --global

--project-dir
    Specify the project directory. Useful when running the command outside of a PlatformIO project.

DESCRIPTION

The pio-lib command is a command-line interface (CLI) tool for managing libraries within the PlatformIO ecosystem. PlatformIO is an open source ecosystem for IoT development. pio-lib allows users to search, install, update, and uninstall libraries, as well as manage library dependencies for their projects.

It's a crucial tool for efficiently integrating and managing external code and functionality in embedded and IoT projects.

With pio-lib you can:
- Search for libraries by name, keywords, or authors.
- Install libraries from the PlatformIO Registry, a Git repository, or a local directory.
- Update installed libraries to the latest versions.
- Uninstall libraries that are no longer needed.
- List installed libraries.

EXAMPLES

Install a library:
pio lib install "WiFiEspAT"

Uninstall a library:
pio lib uninstall "WiFiEspAT"

Search for libraries:
pio lib search "WiFi"

Update all installed Libraries:
pio lib update

SEE ALSO

pio(1), pio-project(1), pio-pkg(1)

Copied to clipboard