• What is PlatformIO?

Getting Started

  • PlatformIO IDE
  • PlatformIO Core (CLI)
    • Installation
      • System Requirements
      • Installation Methods
        • Installer Script (Recommended)
        • Python Package Manager
        • Homebrew (macOS)
      • Development Version
      • Install Shell Commands
      • 99-platformio-udev.rules
      • Integration with custom applications (extensions, plugins)
      • Proxy Configuration
      • Troubleshooting
      • Uninstall PlatformIO Core and dependent packages
    • Quick Start
    • CLI Guide
  • PlatformIO Home
  • PlatformIO Account
  • Tutorials and Examples

Configuration

  • platformio.ini
  • Build Configurations
  • Environment Variables

Instruments

  • Library Management
  • Platforms
  • Frameworks
  • Boards
  • Custom Platform & Board

Advanced

  • Scripting
  • Debugging
  • Unit Testing
  • Static Code Analysis
  • Remote Development

Integration

  • Cloud & Desktop IDEs
  • Continuous Integration
  • Compilation database compile_commands.json

Miscellaneous

  • FAQ
  • Release Notes
  • Migrating from 5.x to 6.0
PlatformIO
  • PlatformIO Core (CLI)
  • Installation
  • Installation Methods
  • Installer Script (Recommended)
  • Edit on GitHub

Installer Script (Recommended)

Warning

PlatformIO operates without the need for administrative or sudo permissions. It is strongly advised to perform the installation using the default user account and without any additional permissions. This approach ensures a smooth installation process and helps maintain a secure and controlled environment.

Note

To facilitate the integration of PlatformIO Core with Continuous Integration systems and containers, we highly recommend installing PlatformIO Core directly from the Python Package Manager. This method is not only the fastest but also the most straightforward way to ensure a seamless setup.

Install PlatformIO Core into the Virtual Python Environment using the Installer Script.

A default location of Python virtual environment is “core_dir/penv”. If you have any issues with PlatformIO Core, just remove this folder and re-run installer script.

  • Super-Quick (macOS / Linux)

  • Local Download (macOS / Linux / Windows)

Super-Quick (macOS / Linux)

To install or upgrade PlatformIO Core paste that at a Terminal prompt:

Using curl

curl -fsSL -o get-platformio.py https://raw.githubusercontent.com/platformio/platformio-core-installer/master/get-platformio.py
python3 get-platformio.py

or using wget

wget -O get-platformio.py https://raw.githubusercontent.com/platformio/platformio-core-installer/master/get-platformio.py
python3 get-platformio.py

Local Download (macOS / Linux / Windows)

To install or upgrade PlatformIO Core, download (save as...) get-platformio.py script. Then run the following:

# change directory to the folder where is located downloaded "get-platformio.py"
cd /path-to-dir/where/get-platformio.py/is-located

# run it
python get-platformio.py

On Windows OS it may look like this:

# change directory to the folder where is located downloaded "get-platformio.py"
cd C:/path-to-dir/where/get-platformio.py/is-located

# run it
python.exe get-platformio.py

Note

If you need to have access to pio or pio.exe commands from other applications or terminals in your OS, please Install Shell Commands.

Previous Next

© Copyright 2014-present, PlatformIO.

Documentation v6.1.19a2 (latest)
Versions
latest
stable
On Github
View
Edit
Search