..  Copyright (c) 2014-present PlatformIO <contact@platformio.org>
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

.. _cmd_lib_show:

platformio lib show
===================

.. contents::

Usage
-----

.. code-block:: bash

    platformio lib show [LIBRARY]
    pio lib show [LIBRARY]


Description
-----------

Show detailed info about a library using
`PlatformIO Library Registry <https://platformio.org/lib>`_.

The possible values for ``[LIBRARY]``:

* Library ID from Registry (preferred)
* Library Name

Options
-------

.. program:: platformio lib show

.. option::
    --json-output

Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format

Examples
--------

.. code::

    > platformio lib show OneWire

    PubSubClient
    ============
    #ID: 89
    A client library for MQTT messaging. MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages. It supports the latest MQTT 3.1.1 protocol and can be configured to use the older MQTT 3.1...

    Version: 2.6, released 10 months ago
    Manifest: https://raw.githubusercontent.com/ivankravets/pubsubclient/patch-2/library.json
    Homepage: http://pubsubclient.knolleary.net
    Repository: https://github.com/knolleary/pubsubclient.git

    Authors
    -------
    Nick O'Leary https://github.com/knolleary

    Keywords
    --------
    ethernet
    mqtt
    iot
    m2m

    Compatible frameworks
    ---------------------
    Arduino

    Compatible platforms
    --------------------
    Atmel AVR
    Atmel SAM
    Espressif 8266
    Intel ARC32
    Microchip PIC32
    Nordic nRF51
    Teensy
    TI MSP430

    Headers
    -------
    PubSubClient.h

    Examples
    --------
    http://dl.platformio.org/libraries/examples/0/89/mqtt_auth.ino
    http://dl.platformio.org/libraries/examples/0/89/mqtt_basic.ino
    http://dl.platformio.org/libraries/examples/0/89/mqtt_esp8266.ino
    http://dl.platformio.org/libraries/examples/0/89/mqtt_publish_in_callback.ino
    http://dl.platformio.org/libraries/examples/0/89/mqtt_reconnect_nonblocking.ino
    http://dl.platformio.org/libraries/examples/0/89/mqtt_stream.ino

    Versions
    --------
    2.6, released 10 months ago

    Downloads
    ---------
    Today: 25
    Week: 120
    Month: 462
