pio-home
Open PlatformIO Home in a web browser
TLDR
Open PlatformIO Home in the default web browser
Use a specific HTTP port (defaults to 8008)
Bind to a specific IP address (defaults to 127.0.0.1)
Do not automatically open PlatformIO Home in the default web browser
Automatically shutdown the server on timeout (in seconds) when no clients are connected
Specify a unique session identifier to keep PlatformIO Home isolated from other instances and protected from 3rd party access
SYNOPSIS
pio home
DESCRIPTION
The `pio home` command launches the PlatformIO Home interface, a graphical user interface (GUI) designed to simplify embedded system development with PlatformIO.
PlatformIO Home provides a visual environment for managing projects, libraries, platforms, and devices. It allows developers to:
- Browse and install development platforms and libraries.
- Create, open, and manage PlatformIO projects.
- Monitor connected devices (e.g., serial ports).
- Access PlatformIO documentation and resources.
Essentially, it's a visual wrapper around many command-line functionalities, offering a more user-friendly experience, especially for beginners. It runs as a web application accessible through your browser. It is a valuable tool for rapid prototyping and project development within the PlatformIO ecosystem, offering a streamlined workflow and enhanced usability.
CAVEATS
PlatformIO Home requires a web browser to be used and consumes system resources while running as a web application.
The command execution may require internet access to function correctly, especially to download libraries and platforms.
RUNNING PLATFORMIO HOME
Executing `pio home` will typically launch a local web server and open PlatformIO Home in your default web browser. If the browser doesn't open automatically, the command output will provide the URL to access the interface manually (usually `http://localhost:8008`). The server continues running in the background until you explicitly terminate it, or close the terminal window from which you launched the command.
BROWSER COMPATIBILITY
While generally compatible with most modern web browsers, it's recommended to use a recent version of Chrome, Firefox, Safari, or Edge for the best experience with PlatformIO Home. Ensure your browser has JavaScript enabled.
HISTORY
PlatformIO Home was introduced as a component of the PlatformIO IDE and CLI tools to provide a user-friendly graphical interface for managing and interacting with the PlatformIO ecosystem.
Its development aimed to lower the barrier to entry for embedded system development by abstracting away some of the complexities of command-line usage and configuration.
Over time, it has been enhanced with new features and improved integration with other PlatformIO tools.
SEE ALSO
pio project(1), pio lib(1), pio platform(1)