Run a CLI command

Run a CLI command

Run a command-line interface (CLI) command.
Install
FactoryTalk Optix Studio
. See FactoryTalk Optix Installation Guide.
  1. To run a CLI command
  2. Open the command prompt.
  3. In the command prompt, enter
    "C:\Program Files\Rockwell Automation\FactoryTalk Optix\
    version
    \FTOptixStudio"
     followed by the available commands and parameters.
    Where
    version
     is the directory that represents the version of
    FactoryTalk Optix Studio
     installed on your system.
    For more information about the available commands and parameters, see CLI commands.
    TIP:
    The following commands assume that you installed
    FactoryTalk Optix Studio
     in the default location. If you selected a custom location for your
    FactoryTalk Optix Studio
     installation, modify the paths accordingly.
    To shorten the commands and invoke the executable with
    FTOptixStudio
    , add a system environment variable or navigate to the
    FactoryTalk Optix Studio
     installation directory.
    For example, enter
    "C:\Program Files\Rockwell Automation\FactoryTalk Optix\
    version
    \FTOptixStudio" --help
     to display a summary of the available commands in the command prompt.
The CLI command executes. The graphical user interface (GUI) may display for some commands.
When the command execution completes, you may see the following exit codes:
Exit codes
Exit code
Description
0
Operation succeeded.
-1
Operation failed.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.