pio pkg install¶

Registry: Latest Version¶

Specification: <owner>/<name>

Install the latest package version from the PlatformIO Registry.

Examples

1. Install ArduinoJson and Embedded Template libraries, and add them to the project dependencies (lib_deps):

   pio pkg install --library "bblanchon/ArduinoJson" --library "etlcpp/Embedded Template Library"
   

2. Declare ArduinoJson and Embedded Template libraries as the project dependencies using lib_deps configuration option:

   [env:myenv]
   lib_deps =
       bblanchon/ArduinoJson
       etlcpp/Embedded Template Library
   

3. Install SEGGER J-Link Software for debug probes:

   pio pkg install --tool "platformio/tool-jlink"
   

Registry: Specific Version¶

Specification: <owner>/<name>@<version>

Install the specified version of a package from the PlatformIO Registry. This will fail if the version has not been published to the registry.

Example

bblanchon/ArduinoJson@6.9.12

Registry: Version Requirements¶

Specification: <owner>/<name>@<version requirements>

Install the latest version of a package from the PlatformIO Registry matching the specified version requirements. See Version Requirements for details.

Example

bblanchon/ArduinoJson@>=6,!=6.13.0

Repository (git, hg, svn)¶

Specification: [<name>=][<scheme>://][<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish|branch|tag>]

Install the package at the specified URL by attempting to clone it. If the repository makes use of submodules, those submodules will be cloned as well.

The supported schemes are:

• http

• https

• git

• git+http

• git+https

• git+ssh

• hg+http

• hg+https

• hg+ssh

• svn+http

• svn+https

• svn+ssh

You can override a package folder name in the Package Manager storage using the <name>= syntax. See the example below.

Examples

1. Clone default branch of Github repository using HTTPS

   https://github.com/platformio/platform-espressif32.git
   

2. Clone default branch of Github repository using SSH

   git@github.com:platformio/platform-espressif32.git
   
   # or
   
   git+username@github.com:platformio/platform-espressif32.git
   

3. Clone Git repository using SSH and custom username

   git+ssh://git.server.org/my-platform
   
   # or
   
   git+ssh://user@git.server.org/my-platform
   

4. Clone “master” branch of Git repository

   https://github.com/platformio/platform-espressif32.git#master
   

5. Clone “v3.3.0” tag of Git repository

   https://github.com/platformio/platform-espressif32.git#v3.3.0
   

6. Clone specified commit of Git repository

   https://github.com/platformio/platform-espressif32.git#084131f6634c818485781651d76818cd1f13a461
   

7. Clone specified commit of Git repository and set custom package folder name to “ESP32”

   ESP32=https://github.com/platformio/platform-espressif32.git#084131f6634c818485781651d76818cd1f13a461
   

8. Clone Mercurial repository

   hg+hg://hg.server.org/my-package
   hg+https://hg.server.org/my-package
   hg+ssh://hg.server.org/my-package
   

Local Folder¶

Install a package and its dependencies from a local folder. A path should start with file:// or symlink:// prefix and the package folder must contain a manifest file (library.json, platform.json, or package.json) with name and version properties.

You can override a package folder name in the Package Manager storage using the <name>= syntax. See the example below.

Examples

# Unix, hard copying
file:///local/path/to/the/package/dir

# Windows, symbolic link
symlink://C:/local/path/to/the/package/dir

# Custom package folder name "SomeLib" in the storage
SomeLib=file:///local/path/to/the/package/dir

Local TAR or ZIP archive¶

Specification: [<name>=]file://<tar or zip file>

Install a package and its dependencies from a local TAR or ZIP archive.

Archive requirements:

• the filename must use .tar.gz, .tar, .tgz, or .zip as the extension

• the package must contain a manifest file (library.json, platform.json, or package.json) with name and version properties.

You can override a package folder name in the Package Manager storage using the <name>= syntax. See the example below.

Examples

# tar.gz
file:///local/path/to/the/archive.tar.gz

# zip
file:///local/path/to/the/archive.zip

# Custom package folder name "SomeLib" in the storage
SomeLib=file:///local/path/to/the/archive.tar.gz

Remote TAR or ZIP archive¶

Specification: [<name>=]<archive url>

Fetch the archive URL, and then install a package and its dependencies. The URL must start with http:// or https://.

You can override a package folder name in the Package Manager storage using the <name>= syntax. See the example below.

Examples

# TAR archive
https://github.com/bblanchon/ArduinoJson/archive/refs/heads/6.x.tar.gz

# ZIP archive
https://github.com/bblanchon/ArduinoJson/archive/refs/heads/6.x.zip

# Custom package folder name "JSON" in the storage
JSON=https://github.com/bblanchon/ArduinoJson/archive/refs/heads/6.x.tar.gz