Skip to main content

CLI Commands

In order to execute commands from the command line, the CLI command <directory>CODESYS.exe is provided with the parameters below. Parameters which use an argument have delimited the added argument with "=" or ":".

Example:

C:\Program Files (x86)\3S CODESYS\CODESYS\Common\CODESYS.exe --profile="CODESYS V3.5 SP13" --project="D:\CODESYS_Test\File_Based_Storage_Commandlineproject\MultipleProjects.fbsws" --workspaceIndex=1

Tip

Include arguments which contain spaces, minus signs, or slashes enclosed by straight quotation marks: "<argument>".

Tip

You can also click Copy command line to clipboard to generate the command.

Parameter

Requirement: CODESYS is started and the specified project is open.

Parameter

--profile="<profile name>"

You need to specify the profile name exactly as it is displayed in the Help → About splash screen of the development system or in the start menu on your computer.

Example: CODESYS.exe --culture=de --profile="CODESYS V3.6"

--project="<path of project file>"

File path to the CODESYS File-Based Storage project

Supported file extensions:

  • *.fbsproj

  • *.fbslib

  • *.fbsws

Example: CODESYS.exe --project="D:\CODESYS_Test\File_Based_Storage_Commandozeilenprojekt\fbs_Project.fbsproj"

--workspaceIndex=<index>

If the workspace defines more than one project, then use the --workspaceIndex parameter via the command line to select the respective project.

This parameter applies only to *.fbsws-files.

--workspaceIndex is a zero-based index.

Example: CODESYS.exe --project="D:\CODESYS_Test\File_Based_Storage_Commandlineproject\MultipleProjects.fbsws" --workspaceIndex=2

In this section: