cmd_home.rst

pio home

Helper command for :ref:`piohome`.

Contents

• Usage
• Description
• Options
• Examples

Usage

pio home

Description

Launch :ref:`piohome` Web-server.

Options

.. program:: pio home

.. option::
    --port

Web-server HTTP port, default is 8008.

.. option::
    --host

Web-server HTTP host, default is 127.0.0.1. You can open PlatformIO Home for inbound connections using host 0.0.0.0.

.. option::
    --no-open

Do not automatically open PlatformIO Home in a system Web-browser.

.. option::
    --shutdown-timeout

Automatically shutdown server on timeout (in seconds) when no clients are connected. Default is 0 which means never auto shutdown.

.. option::
    --session-id

A unique session identifier to keep PlatformIO Home isolated from other instances and protect from 3rd party access.

Warning

If a unique session ID is not specified (default mode), PlatformIO Home will be accessible by any user from your machine using if he knows --host and --port.

Examples

> pio home

  ___I_
 /\-_--\   PlatformIO Home
/  \_-__\
|[]| [] |  http://127.0.0.1:8008
|__|____|_______________________

Open PlatformIO Home in your browser by this URL => http://127.0.0.1:8008
PlatformIO Home has been started. Press Ctrl+C to shutdown.