You can launch the Project Creator in various ways based on your operating system and how you work.
As a stand-alone GUI tool
Launch the Project Creator as a stand-alone GUI tool by running its executable for your operating system (for example, select it using the Windows Start menu or the macOS Finder). By default, it is installed here:
<install_dir>/ModusToolbox/tools_<version>/project-creator
GUI command-line options
The Project Creator GUI provides several useful command-line options that you can use when launching the GUI. The following table shows each option and its corresponding purpose:
| Option | Description |
|---|---|
|
|
Closes the GUI once the project creation is complete. |
|
|
Sets the value of the Target IDE field on the Application page. The <IDE Name> can be one of the following: eclipse, vscode, ewarm, uvision, none. |
|
|
Causes the Target IDE field in the project-creator to be read-only. |
|
|
Outputs project creation status in a JSON format to the standard output. |
|
|
When launching from the executable, you can add this option to specify more or less messaging in the message console. The default level is 1. |
From the Dashboard
The Dashboard tool allows you to launch the Project Creator for a given IDE. Refer to the Dashboard user guide for more details.
VS Code and Eclipse
VS Code and Eclipse have tools to launch the Project Creator tool. Refer to the applicable user guide for more details:
As a command-line tool
You can also use the project-creator-cli
executable to create applications from a command-line prompt or from within batch files or
shell scripts. The exit code for the CLI is zero if the operation is successful, or
non-zero if the operation encounters an error. For Windows, use the modus-shell bash
installed in the ModusToolbox™ "tools" directory. For macOS and Linux, use the appropriate
bash for your system.
The project-creator-cli executable is
located in the same directory as the GUI version of the tool (<install_dir>/ModusToolbox/tools_<version>/project-creator/). To see
all the options available, run the tool with the -h
option:
$ project-creator-cli -hThe following example shows running the tool with the basic options to specify a BSP, application, and SDK:
./project-creator-cli.exe \
--board-id KIT_PSE84_EVAL_EPC2 \
--app-id mtb-example-psoc-edge-hello-world \
--target-dir C:/examples/5-19-edge \
--user-app-name PSOC_Edge_Hello_World \
--use-modus-shell \
--sdk-id psoc-edge-e84 \
--sdk-version 1.0.0