Skip to content

stm32pio help

Jump to bottom
ussserrr edited this page Oct 29, 2020 · 3 revisions

stm32pio --help

usage: stm32pio [-h] [--version] [-v] {init,generate,patch,new,status,clean,gui} ...

Automation of creating and updating STM32CubeMX-PlatformIO projects. Requirements: Python 3.6+, STM32CubeMX, Java, PlatformIO CLI. Visit https://github.com/ussserrr/stm32pio
for more information. Use 'help' command to take a glimpse on the available functionality

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         enable verbose output (default: INFO)

subcommands:
  valid subcommands

  {init,generate,patch,new,status,clean,gui}
                        available actions
    init                create config .ini file to check and tweak parameters before proceeding
    generate            generate CubeMX code only
    patch               tweak the project so the CubeMX and PlatformIO could work together
    new                 generate CubeMX code, create PlatformIO project, glue them together
    status              get the description of the current project state
    clean               clean-up the project (delete ALL content of 'path' except an .ioc file)
    gui                 start the graphical version of the application. All arguments will be passed forward, see its own --help for more information

stm32pio init --help

usage: stm32pio init [-h] [-d PATH] [-b BOARD] [--start-editor EDITOR]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)
  -b BOARD, --board BOARD
                        PlatformIO name of the board
  --start-editor EDITOR
                        use specified editor to open the PlatformIO project (e.g. subl, code, atom, etc.)

stm32pio new --help

usage: stm32pio new [-h] [-d PATH] [-b BOARD] [--start-editor EDITOR] [--with-build]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)
  -b BOARD, --board BOARD
                        PlatformIO name of the board
  --start-editor EDITOR
                        use specified editor to open the PlatformIO project (e.g. subl, code, atom, etc.)
  --with-build          build the project after generation

stm32pio generate --help

usage: stm32pio generate [-h] [-d PATH] [--start-editor EDITOR] [--with-build]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)
  --start-editor EDITOR
                        use specified editor to open the PlatformIO project (e.g. subl, code, atom, etc.)
  --with-build          build the project after generation

stm32pio patch —help

usage: stm32pio patch [-h] [-d PATH]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)

stm32pio status --help

usage: stm32pio status [-h] [-d PATH]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)

stm32pio clean --help

usage: stm32pio clean [-h] [-d PATH] [-q]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)
  -q, --quiet           suppress the caution about the content removal (be sure of what you are doing!)

stm32pio gui —help

usage: stm32pio gui [-h] [-d PATH] [-b BOARD]

optional arguments:
  -h, --help            show this help message and exit
  -d PATH, --directory PATH
                        path to the project (current directory, if not given)
  -b BOARD, --board BOARD
                        PlatformIO name of the board
Clone this wiki locally