Manipulate CS+ on the Command Line

2.13 Manipulate CS+ on the Command Line

You can launch CS+ from the command line (e.g. the Windows command prompt), and control it via command input without displaying the Main window.

This section describes the control of CS+ when launched from the Windows command prompt.

From the command prompt, execute CubeSuite+.exe or CubeSuiteW+.exe, located in the CS+ installation folder.

(1)	When executing CubeSuite+.exe

If you execute CubeSuite+.exe, you can launch CS+, load plug-ins, and execute builds without displaying the Main window.

The format to specify on the command line is shown below.

CubeSuite+.exeΔ[

                   [Δ/bbΔ[build-mode-name]]

                  |[Δ/brΔ[build-mode-name]]

                  |[Δ/bcbΔ[build-mode-name]]

                  |[Δ/bcΔ[build-mode-name]]

                  |[Δ/bol]

                  |[Δ/odpΔ[of=output-folder-path][Δbuild-mode-name]]

                  |[Δ/cve]

                   [Δ/npΔplug-in-name[,plug-in-name,...]][Δ/npall]

                   [Δ/lpΔplug-in-name[,plug-in-name,...]][Δ/lpall]

                [Δ/langΔlanguage-for-display]

                   [Δ[plug-in-option[Δplug-in-parameter,...]]

                                         Δproject-file-name

Δ: One or more spaces

[ ]: Can be omitted

{}|: When options are separated by pipeline characters ("|"), any one of the options can be specified

...: Pattern in proceeding [ ] can be repeated

Each option is described below.

Option

Description

None

Launch CS+ without displaying the Main window, and exit without performing any actions.

/bbΔ[build-mode-name]

Execute a build.

Launch without displaying the Main window, build all the projects included in specified project-file-name, with the build mode specified by build-mode-name, and then exit.

If a project does not have the build mode specified by build-mode-name, then the build mode is copied based on the DefaultBuild, and the build is performed.

If the build mode specified by build-mode-name is not defined in the project specified by project-file-name, then an error will be displayed, and processing will end.

If build-mode-name is omitted, then the build will use the DefaultBuild.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/brΔ[build-mode-name]

Execute a rebuild.

Launch without displaying the Main window, build all the projects included in specified project-file-name, with the build mode specified by build-mode-name, and then exit.

If a project does not have the build mode specified by build-mode-name, then the build mode is copied based on the DefaultBuild, and the build is performed.

If the build mode specified by build-mode-name is not defined in the project specified by project-file-name, then an error will be displayed, and processing will end.

If build-mode-name is omitted, then the build will use the DefaultBuild.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/bcbΔ[build-mode-name]

Perform a clean and then execute a build.

Launch without displaying the Main window, build all the projects included in specified project-file-name, with the build mode specified by build-mode-name, and then exit.

If a project does not have the build mode specified by build-mode-name, then the build mode is copied based on the DefaultBuild, and the build is performed.

If the build mode specified by build-mode-name is not defined in the project specified by project-file-name, then an error will be displayed, and processing will end.

If build-mode-name is omitted, then the build will use the DefaultBuild.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/bcΔ[build-mode-name]

Perform a clean.

Launch without displaying the Main window, build all the projects included in specified project-file-name, with the build mode specified by build-mode-name, and then exit.

If a project does not have the build mode specified by build-mode-name, then the build mode is copied based on the DefaultBuild, and the build is performed.

If the build mode specified by build-mode-name is not defined in the project specified by project-file-name, then an error will be displayed, and processing will end.

If build-mode-name is omitted, then the build will use the DefaultBuild.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/bol

Execute [Build Option List].
Launch without displaying the Main window, display a list of build options for all projects included in the specified project-file-name, and then exit the program.

Options for all build modes are displayed, in the same way as when executing [Build] - [Build Options List]. If a project-file-name is omitted, then an error will be displayed, and processing will end.

/odpΔ[of=output-folder-path][Δbuild-mode-name]

Output a dependency-information file.

This option outputs a dependency-information file, and then exit the program without displaying the Main window.

The file to be output includes the dependency information in the build mode specified with build-mode-name of all projects in the project file specified with project-file-name.

When of=output-folder-path is specified, the file is output to the specified folder (the folder is created if not already present).

When of=output-folder-path is omitted, a subfolder with a name of the form "QualityRecordYYYYMMDDThhmmss" is automatically created in the project folder for output of the file.

If build-mode-name is omitted, DefaultBuild is used as the build mode for the output of the file.

If project-file-name is omitted, an error message will be displayed and processing will abort.

The output format is the same as that for dependency information that is output with [Output Data for Quality Records Collectively] in the Smart Report dialog box. The name of the output file is <project name>.deps.

Caution

No information on syntactic errors will be output in the processing for acquiring dependencies. Be sure to confirm the absence of build errors in advance.

/cve

Convert a project for CA78K0R or CA78K0 to one for CC-RL and output a common project file (*.rcpe).

Remark

The common project file (*.rcpe) is a project file that can be output by CS+ and loaded by the e2 studio that supports this file format.
Use the import function of e2 studio to load the common project file (*.rcpe).

Launch without opening the Main window, convert all the projects included in specified project-file-name, and then exit.

The output folder is the same folder as that of project-file-name, and the output file name is the same as project-file-name with its extension changed to ".rcpe".

The device of the project and subprojects of the conversion source is directly used as the device of conversion destination.

If project-file-name is omitted, then an error will be displayed, and processing will end.

The following conversion is supported.

Build Tool of Conversion Source

Build Tool of Conversion Destination

CA78K0R

CC-RL

CA78K0

CC-RL

/lpΔplug-in-name[,plug-in-name,...]

Start CS+ without displaying the Main window, and with loading the specified plug-ins in the Plugins folder.

In plug-in-name, specify the name of the folder in which each DLL file is saved. However, if the name of the folder is “plugin name_nnn” (nnn is a decimal value), the file name does not include “_nnn”.Note that folder names are case-insensitive.

You can specify multiple plug-in names by separating them with commas.

You can also specify the "/lp" option itself multiple times. Each DLL will be loaded.

When a plug-in with the same name is specified for the /np option, the option specified backward of the command line will take precedence.

If the plug-in specified by this option does not exist, it will be ignored.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/lpall

Start CS+ without displaying the Main window, and with loading all plugins in the Plugins folder.

If this is specified together with the "/np" or “/lp” option, then this option will take precedence. When a plug-in is specified together with the /npall option, the option specified backward of the command line will take precedence.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/npΔplug-in-name[,plug-in-name,...]

Start CS+ without displaying the Main window, and without loading the specified plugins in the Plugins folder.

You can specify multiple plug-in names by separating them with commas.

You can also specify the "/np" option itself multiple times. Each DLL will not be loaded.

When a plug-in with the same name is specified for the /lp option, the option specified backward of the command line will take precedence.

If the plug-in specified by this option does not exist, it will be ignored.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/npall

Start CS+ without displaying the Main window, and without loading any of the specified plugins in the Plugins folder.

If this is specified together with the "/np" or “/lp” option, then this option will take precedence. When a plug-in is specified together with the /lpall option, the option specified backward of the command line will take precedence.

If project-file-name is omitted, then an error will be displayed, and processing will end.

/langΔlanguage-for-display

Specify this option when the language for display is different from that for the OS.Note

language-for-display

Description

ja-JP

Displays the language in Japanese.

en-US

Displays the language in English.

plug-in-optionΔ[plug-in-parameter,...]

Specify an option for the plug-in (see "(3) Plug-in Options").

project-file-name

Start CS+ without displaying the Main window, with the specified project file (with ".mtpj" extension) loaded.

Remark 1.

When the "/lp", "/lpall", "/np", or "/npall" option is specified, the settings of the Plug-in Manager dialog box are not changed.

Remark 2.

While CS+ is running, press the [Ctrl] + [C] keys to forcibly terminate CS+.

Remark 3.

When the /bb, /br, or /bcb option is specified, the build is run in accord with the setting of the [General - Build] category in the Option dialog box. For example, when [Project folder] is selected for [Output destination of the result of updating dependencies], a dependency-information file is output to the project folder.

Note

If "ja-JP" is specified for /lang in a non-Japanese OS, text in the messages output by the CC-RL and CC-RH compilers will be garbled.
Names such as event names that have been saved in the project file (*.mtpj or *.mtud) or Information set for each user of the PC (c1_user.mtpu) will be displayed as they are.

The results of execution are output to the command prompt.

Figure 2.112

Command Prompt (If Build Is Executed with CubeSuite+.exe)

(2)	When executing CubeSuiteW+.exe

Execute CubeSuiteW+.exe to launch CS+, displaying the Main window and with plugins loaded, in the same manner as when launching it from the [Start] menu.

The format to specify on the command line is shown below.

CubeSuiteW+.exe[Δ/npΔplug-in-name[,plug-in-name,...]]Δ[/npall]

                                    [Δ[/lpΔplug-in-name[,plug-in-name,...]]Δ[/lpall]Δ[/noproj]

                                    [Δ/nrs]Δ[/langΔlanguage-for-display]

                                    [Δplug-in-optionΔ[plug-in-parameter,...]]

               [Δproject-file-name]

Δ: One or more spaces

[ ]: Can be omitted

...: Pattern in proceeding [ ] can be repeated

Each option is described below.

Option	Description
None	Start CS+ with the Main window displayed, in the same manner as when launching it from the [Start] menu.
/lpΔplug-in-name[,plug-in-name,...]	Start CS+ displaying the Main window, with loading the specified plugins in the Plugins folder. In plug-in-name, specify the name of the folder in which the DLL file is saved. However, if the name of the folder is “plugin name_nnn” (nnn is a decimal value), the file name does not include “_nnn”. Note that folder names are case-insensitive. You can specify multiple plug-in names by separating them with commas. You can also specify the "/lp" option itself multiple times. Each DLL will be loaded. When a plug-in with the same name is specified for the /np option, the option specified backward of the command line will take precedence. If the plug-in specified by this option does not exist, it will be ignored.
/lpall	Start CS+ displaying the Main window, with loading all plug-ins in the Plugins folder. If an invalid option is specified, it will be ignored.
/npΔplug-in-name[,plug-in-name,...]	Start CS+ displaying the Main window, without loading the specified plugins in the Plugins folder. In plug-in-name, specify the name of the folder in which the DLL file is saved. However, if the name of the folder is “plugin name_nnn” (nnn is a decimal value), the file name does not include “_nnn”.Note that folder names are case-insensitive. You can specify multiple plug-in names by separating them with commas. You can also specify the "/np" option itself multiple times. Each DLL will not be loaded. When a plug-in with the same name is specified for the /lp option, the option specified backward of the command line will take precedence. If the plug-in specified by this option does not exist, it will be ignored.
/npall	Start CS+ displaying the Main window, without loading any of the specified plug-ins in the Plugins folder. If an invalid option is specified, it will be ignored.
/noproj	Start CS+ displaying the Main window without reading in a project (either a project specified on the command line, or the last used project).
/nrs	If CS+ is already started and in the standby state using rapid start (see "2.2 Start CS+"), ignore this and start another process.
/langΔlanguage-for-display	Specify this option when the language for display is different from that for the OS.Note
	language-for-display	Description
	ja-JP	Displays the language in Japanese.
	en-US	Displays the language in English.
plug-in-optionΔ[plug-in-parameter,...]	Specify an option for the plug-in (see "(3) Plug-in Options").
project-file-name	Start CS+ displaying the Main window, with the specified project file (with ".mtpj" extension) loaded.

Remark

When the "/lp", "/lpall", "/np", or "/npall" option is specified, the settings of the Plug-in Manager dialog box are not changed.

Note

If "ja-JP" is specified for /lang in a non-Japanese OS, CS+ will operate as follows.
- Descriptions in the Customize Keyboard dialog box will be written in English.
- Text in the messages output by the CC-RL and CC-RH compilers will be garbled.
Names such as event names that have been saved in the project file (*.mtpj or *.mtud) or Information set for each user of the PC (c1_user.mtpu) will be displayed as they are.
This is not effective for external programs such as those for starting external tools.

(3)	Plug-in Options

Below are the plug-in options that can be specified.

Option

Description

/psΔscript-file-name

This is the Python Console plug-in option.

After loading the project file in CS+, run the code in script-file-name.

If an unnecessary parameter is specified, and the script file cannot be loaded, then an error will be displayed, and the script file will not be executed.

A sample script file is shown below.

debugger.Connect()

debugger.Download.LoadModule(r"C:\project\test\DefaultBuild\test.out")

debugger.Register.GetValue("pc")

breakpoint = BreakCondition()

breakpoint.Address = "func"

debugger.Breakpoint.Set(breakpoint)

debugger.Go(GoOption.WaitBreak)

debugger.Register.GetValue("pc")