..  Copyright (c) 2014-present PlatformIO <contact@platformio.org>
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

.. _piocore_userguide:

CLI Guide
=========

.. contents::

Usage
-----

.. code-block:: bash

    pio [OPTIONS] COMMAND

Options
-------

.. program:: pio

.. option::
    --no-ansi

Do not print ANSI control characters.

See also :envvar:`PLATFORMIO_NO_ANSI` and :envvar:`PLATFORMIO_FORCE_ANSI`
environment variables.


.. option::
    --version

Show the version of PlatformIO

.. option::
    --help, -h

Show help for the available options and commands

.. code-block:: bash

    $ pio --help
    $ pio COMMAND --help


Commands
--------

.. toctree::
    :maxdepth: 2

    access/index
    account/index
    cmd_boards
    cmd_check
    cmd_ci
    cmd_debug
    pio device <device/index>
    cmd_home
    pio lib <lib/index>
    org/index
    pio pkg <pkg/index>
    pio platform <platforms/index>
    pio project <project/index>
    pio remote <remote/index>
    cmd_run
    cmd_settings
    system/index
    team/index
    cmd_test
    cmd_update
    cmd_upgrade
