Skip to content

stm32pio help

Jump to bottom
ussserrr edited this page Mar 15, 2020 · 3 revisions

stm32pio --help

usage: __main__.py [-h] [--version] [-v] {init,new,generate,status,clean} ...

Automation of creating and updating STM32CubeMX-PlatformIO projects.
Requirements: Python 3.6+, STM32CubeMX, Java, PlatformIO CLI. Run 'init'
command to create config file and set the path to STM32CubeMX and other tools
(if defaults doesn't work for you)

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,new,generate,status,clean}
                        modes of operation
    init                create config .ini file so you can tweak parameters
                        before proceeding
    new                 generate CubeMX code, create PlatformIO project
    generate            generate CubeMX code only
    status              get the description of the current project state
    clean               clean-up the project (delete ALL content of 'path'
                        except the .ioc file)

stm32pio init --help

usage: __main__.py init [-h] [-d PROJECT_PATH] [-b BOARD]
                        [--start-editor EDITOR]

optional arguments:
  -h, --help            show this help message and exit
  -d PROJECT_PATH, --directory PROJECT_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: __main__.py new [-h] [-d PROJECT_PATH] [-b BOARD]
                       [--start-editor EDITOR] [--with-build]

optional arguments:
  -h, --help            show this help message and exit
  -d PROJECT_PATH, --directory PROJECT_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: __main__.py generate [-h] [-d PROJECT_PATH] [--start-editor EDITOR]
                            [--with-build]

optional arguments:
  -h, --help            show this help message and exit
  -d PROJECT_PATH, --directory PROJECT_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 status --help

usage: __main__.py status [-h] [-d PROJECT_PATH]

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

stm32pio clean --help

usage: __main__.py clean [-h] [-d PROJECT_PATH] [-q]

optional arguments:
  -h, --help            show this help message and exit
  -d PROJECT_PATH, --directory PROJECT_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!)
Clone this wiki locally