platformio init [OPTIONS]
pio init [OPTIONS]
Initialize new PlatformIO based project or update existing with new data.
This command will create:
src directory where you should place source code
(*.h, *.c, *.cpp, *.S, *.ino, etc.)
lib directory can be used for the project specific (private) libraries.
More details are located in lib/readme.txt file.
Miscellaneous files for VCS and Continuous Integration support.
A path to the directory where PlatformIO will initialize new project.
If you specify board ID (you can pass multiple --board options), then
PlatformIO will automatically generate environment for Project Configuration File platformio.ini and
pre-fill these data:
The full list with pre-configured boards is available here Development Platforms.
Initialize PlatformIO project for the specified IDE which can be imported later via “Import Project” functionality.
A list with supported IDE is available within platformio init --help command.
Also, please take a look at Cloud & Standalone IDE page.
Initialize project with additional options from Project Configuration File platformio.ini. For example,
platformio init --project-option="lib_deps=ArduinoJSON".
Multiple options are allowed.
An environment prefix which will be used with pair in board type.
For example, the default environment name for teensy_31 board will
be [env:teensy_31].
Initialize new project in a current working directory
> platformio init
The current working directory *** will be used for the new project.
You can specify another project directory via
`platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
The next files/directories will be created in ***
platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
src - Put your source files here
lib - Put here project specific (private) libraries
Project has been successfully initialized!
Useful commands:
`platformio run` - process/build project from the current directory
`platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
`platformio run --target clean` - clean project (remove compiled files)
Initialize new project in a specified directory
> platformio init -d %PATH_TO_DIR%
The next files/directories will be created in ***
platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
...
Initialize project for Arduino Uno
> platformio init --board uno
The current working directory *** will be used for the new project.
You can specify another project directory via
`platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
...
Initialize project for Teensy 3.1 board with custom Framework mbed
> platformio init --board teensy31 --project-option "framework=mbed"
The current working directory *** will be used for the new project.
You can specify another project directory via
`platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
...