PlatformIO Project Command Examples (with examples)

pio project init

Initialize a new PlatformIO project

pio project init

Motivation: This command is used to create a new PlatformIO project from scratch. It initializes the project with the basic files and configurations required for PlatformIO.

Explanation:

• pio project init: This command initializes a new PlatformIO project in the current directory.

Example Output:

The current working directory has been successfully initialized as a new PlatformIO project.

pio project init –project-dir

Initialize a new PlatformIO project in a specific directory

pio project init --project-dir path/to/project_directory

Motivation: Sometimes, we want to create a new PlatformIO project in a specific directory instead of the current working directory. This command allows us to specify the project directory.

Explanation:

• pio project init: This command initializes a new PlatformIO project.
• --project-dir: This option allows us to specify the directory where the project should be created.

Example Output:

A new PlatformIO project has been successfully created in the specified directory: path/to/project_directory.

pio project init –board

Initialize a new PlatformIO project, specifying a board ID

pio project init --board ATmega328P|uno|...

Motivation: When creating a new PlatformIO project, we often know the specific board we will be working with. This command allows us to specify the board ID during project initialization.

Explanation:

• pio project init: This command initializes a new PlatformIO project.
• --board: This option allows us to specify the board ID for the project.

Example Output:

A new PlatformIO project has been successfully created with the specified board: ATmega328P.

pio project init –project-option

Initialize a new PlatformIO based project, specifying one or more project options

pio project init --project-option="option=value" --project-option="option=value"

Motivation: Sometimes, we need to customize our PlatformIO project with specific options during initialization. This command allows us to specify one or more project options.

Explanation:

• pio project init: This command initializes a new PlatformIO project.
• --project-option: This option allows us to specify one or more project options. Each project option is formatted as “option=value”.

Example Output:

A new PlatformIO project has been successfully created with the specified project options: 
- option1=value1
- option2=value2

pio project config

Print the configuration of a project

pio project config

Motivation: It is often useful to review the configuration settings of a PlatformIO project. This command allows us to print the project configuration for analysis or troubleshooting.

Explanation:

• pio project config: This command prints the configuration of the current PlatformIO project.

Example Output:

{
  "name": "my_project",
  "platform": "atmelavr",
  "framework": "arduino",
  "board": "uno"
}

The output displays the project configuration in JSON format, including the project name, platform, framework, and the selected board.