LinuxCommandLibrary

pio-platform

Manage development platforms for PlatformIO

TLDR

List all installed development platforms

$ pio platform list
copy

Search for existing development platforms
$ pio platform search [platform]
copy

Show details about a development platform
$ pio platform show [platform]
copy

Install a development platform
$ pio platform install [platform]
copy

Update installed development platforms
$ pio platform update
copy

Uninstall a development platform
$ pio platform uninstall [platform]
copy

List all supported frameworks
$ pio platform frameworks
copy

SYNOPSIS

pio [OPTIONS] COMMAND [ARGS]...

PARAMETERS

--version
    Show program's version number and exit.

-h, --help
    Show help message and exit.

-c , --project-dir
    Specify a custom project directory (by default, the current working directory is used).
Example: 'pio run -c /path/to/my/project'

--skip-pre-release
    Skip pre-release (rc/beta) versions when installing a new platform/package.

--force
    Force installing a new platform/package even if the latest version is already installed.

--no-ansi
    Disable ANSI color output.

--json-output
    Produce output in the JSON format.

--verbose
    Increase verbosity. Print more detailed messages.

--force-subprocess
    Force commands to be executed in a subprocess.

DESCRIPTION

The `pio` command is the central command-line interface for PlatformIO Core (PIO Core). It provides a powerful and versatile environment for managing embedded system development. Using `pio`, developers can streamline tasks such as project creation, dependency management (libraries and frameworks), building, flashing, debugging, testing, and firmware deployment.

It leverages a modular architecture and supports a wide range of hardware platforms, development boards, and toolchains. The command-line interface is highly customizable and can be integrated into various IDEs and CI/CD workflows.

PlatformIO simplifies complex processes, abstracting away the underlying toolchain intricacies and allowing developers to focus on writing code. It promotes portability and reproducibility by managing project dependencies in a consistent manner across different development environments. Developers can also use the command to explore the libraries of prebuilt code available, download and import them to the projects, and build the code.

COMMON COMMANDS

Some common commands include:
- `pio init`: Initialize a new PlatformIO project.
- `pio run`: Build and upload firmware.
- `pio lib`: Manage libraries.
- `pio platform`: Manage platforms.
- `pio device`: Manage devices.

ENVIRONMENT VARIABLES

PlatformIO also uses environment variables to customize its behavior. Commonly used environment variables are PIO_HOME_DIR and PLATFORMIO_CORE_DIR

SEE ALSO

platformio-account(1), platformio-boards(1), platformio-debug(1), platformio-device(1), platformio-lib(1), platformio-package(1), platformio-project(1), platformio-run(1), platformio-settings(1), platformio-test(1), platformio-upgrade(1)

Copied to clipboard