Table Of Contents

Running VeriStand Operations Using the Command Line

Last Modified: June 10, 2021

Use the command line to execute processes in VeriStand, such as deploying or closing a project.

Commands can be used while VeriStand is open or closed.

  1. Open a command prompt.
  2. Change directories to the location of the VeriStand executable.
  3. Execute one of the following commands using the following syntax: VeriStand.exe /<command>.
    spd-note-note
    Note  

    You can use either a slash or a dash before each command. Commands are not case sensitive. For example, /deploy and -DePloY are equivalent commands.

    Command Description
    connect Connects to a deployed system on the gateway. This command executes after commands for creating the project, opening the project, and modifying the system definition. This command is ignored if deploy is also specified. An error returns if a system is not deployed but a project is open.
    disconnect Disconnects from a deployed system on the gateway.
    deploy Deploys the system to the gateway and connects to it. This command executes after commands for creating the project, opening the project, and modifying the system definition.
    editScreen Turns operate mode off to unlock the screen for editing. This can be used to reverse the operateScreen or operateOnly commands while VeriStand is running.
    gateway <IP address or hostname> Specifies the given IP address or hostname as the gateway.
    help Opens the VeriStand manual to Running VeriStand Operations Using the Command Line.
    noDeployKeys Disables the keyboard shortcuts for deploy (F6) and undeploy (F7). This command does not disable the Operate menu or the deploy and undeploy commands.
    nivsprj <file path to .nivsprj file> Opens the specified project. If the project does not exist, VeriStand creates it using the default project template. If VeriStand has a different project open, a dialog box will ask you to save and close it.
    openProject <file path to .nivsprj file>
    operateScreen Turns operate mode on to lock the screen. When operate mode is on, you cannot resize, move, or edit the controls in the screen document. This command disables the screen document unlock button.
    operateOnly
    openDocument <file path to legacy .nivsproj file> Converts a legacy .nivsproj VeriStand project into a .nivsprj file and opens it.
    sysDef <file path to .nivssdf system definition file> Loads the system definition into an open or specified project. If you create a new project with the nivsprj or openProject commands, the specified system definition is used instead of the default template. This command does not work if the gateway is currently connected or connecting. This command executes before the connect command.
    undeploy Removes deployed system from the gateway. This command works on connected and disconnected systems.

Recently Viewed Topics