How to use the command "pio" (with examples)

The “pio” command is a development environment for embedded boards. It provides a range of subcommands that allow users to build, upload, and manage projects for various embedded platforms. This article will illustrate the different use cases of the “pio” command.

Use case 1: Show help and list subcommands

Code:

pio --help

Motivation:

When starting with a new tool or command, it is often helpful to have a comprehensive overview of the available options and subcommands. By using the “pio –help” command, users can quickly access the documentation and get an understanding of what the “pio” command offers.

Explanation:

The “–help” argument is used to display help information about a command or subcommand. In this case, it will display the help message for the “pio” command. It lists the available subcommands and provides a brief description of each one.

Example output:

Usage: pio [OPTIONS] COMMAND [ARGS]...

Development environment for embedded boards.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  init      Initialize new PlatformIO project or update...
  run       Process project environments
  ...

Use case 2: Print the version number and exit

Code:

pio --version

Motivation:

Knowing the version number of a tool or command is important, especially when troubleshooting issues or working with different versions of the same tool. This command allows users to quickly retrieve the version number of the “pio” command.

Explanation:

The “–version” argument is used to print the version number of a command. In the case of the “pio” command, it will display the version number and exit the program.

Example output:

PlatformIO Core, version 5.3.0

Use case 3: Show help for a specific subcommand

Code:

pio subcommand --help

Motivation:

When working with a specific subcommand of the “pio” command, it can be useful to have detailed documentation or help information specifically for that subcommand. This command allows users to access the help message for a specific subcommand.

Explanation:

The “subcommand” placeholder should be replaced with the name of the desired subcommand. The “–help” argument is used to display the help message for the specified subcommand. It provides detailed information about the usage and available options for that subcommand.

Example output:

Usage: pio run [OPTIONS] [SRC]...

Process project environments

Options:
  -t, --environment TEXT            Process specified environments
  -e, --environment-interactive    Interactive mode
  -s, --silent                      Suppress all informational outputs
  ...