• Documentation
  • PlatformIO
  • v6.1.4
PlatformIO
v6.1.4
  • 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)
      • 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
  • Migrating from 5.x to 6.0

Installer Script (Recommended)¶

Warning

PlatformIO DOES NOT require administrative/sudo permissions. Please install using the default user account WITHOUT EXTRA PERMISSIONS.

Install PlatformIO Core into the virtual Python environment using an 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:

python3 -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"

or using curl

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

or using wget

wget https://raw.githubusercontent.com/platformio/platformio-core-installer/master/get-platformio.py -O 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.