Eggplant Command Line Options

This page explains the different options you can use when you run Eggplant Functional scripts from a command line using the Eggplant command. This command launches the Eggplant Functional GUI. Note that if you run one of these options using the runscript command, the Eggplant Functional GUI launches. See Runscript Command Options to learn more about the runscript command.

For more information about these commands, see Running from the Command Line.

Note: We use the term arguments to describe the options you pass with the runscript or Eggplant command when you run those commands from the command line. Other terms you might be familiar with include options and flags.

We use the term parameters to refer to the values that you pass as input to scripts. See Passing Parameters for more information about passing parameters to scripts when you run them from a command line.

-AlertOnError

Use: Specifies whether to show an alert when script execution fails. Valid values: yes/no.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RunOnLaunch /Users/Alex/appTests.suite/Scripts/test3.script -AlertOnError yes

Windows

"C:\Program Files\eggPlant\eggPlant.bat" -RunOnLaunch "C:\Users\Alex\Documents\MyTests.suite\scripts\test3.script" -AlertOnError yes

Linux

Eggplant -RunOnLaunch ~/Documents/appTests.suite/Scripts/test1.script -AlertOnError yes
Note: This parameter overrides the Eggplant Functional General Preference for Alert user when script execution fails.

-AlertOnFailedConnections

Use: Specifies whether to show an alert when a connection fails. Valid values: yes/no.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RunOnLaunch /Users/Alex/appTests.suite/Scripts/test3.script -AlertOnFailedConnections yes

Windows

"C:\Program Files)\eggPlant\eggPlant.bat" -RunOnLaunch "C:\Users\Alex\Documents\MyTests.suite\scripts\test3.script" -AlertOnFailedConnections yes

Linux

Eggplant -RunOnLaunch ~/Documents/appTests.suite/Scripts/test1.script -AlertOnFailedConnections yes
Note: This parameter overrides the Eggplant Functional General Preference for Show alert when a connection fails.

-AutoShowRunWindow

Use: Specifies to bring the Run window forward when the script is run. Valid values: yes/no.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -AutoShowRunWindow yes

Windows

"C:\Program Files\Eggplant\Eggplant.bat" -AutoShowRunWindow yes

Linux (bash shell)

Eggplant -AutoShowRunWindow yes
Note: Overrides the Eggplant Functional General Preference for Bring the Run window forward when a script is run.

-DefaultDocumentDirectory

Use: Specifies the starting directory for relative file paths to suites, such as the paths of helper suites.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -DefaultDocumentDirectory ~/Documents/EggplantDocs

Windows

"C:\Program Files\Eggplant\eggPlant.bat" -DefaultDocumentDirectory "C:\Users\Elizabeth\Documents\eggPlantTests"

Linux

Eggplant ~/Documents/appTests.suite/Scripts/test1.script -DefaultDocumentDirectory ~/Documents
Note: This is the same as the Eggplant Functional General Preference for Default Suite Directory.

-open

Use: The -open argument launches Eggplant Functional from the command line with a suite open. Include the path to the specific suite with the -open argument. The -open argument also can open specific scripts. Include the path to the specific script to do this.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -open ~/Documents/appTests.suite
/Applications/eggPlant.app/Contents/MacOS/Eggplant -open ~/Documents/appTests.suite/scripts/testscript.script

Windows

"C:\Program Files\eggPlant\Eggplant.bat" "C:\Users\Alex\Documents\appTests.suite" -open
"C:\Program Files\eggPlant\Eggplant.bat" "C:\Users\Alex\Documents\appTests.suite\scripts\testscript.script" -open

Linux

Eggplant ~/Documents/appTests.suite -open
Eggplant ~/Documents/appTests.suite/scripts/testscript.script -open

-param (-p)

Use: The -param argument passes parameters to a script. You can use -param before or after the name of the script. Note that the -param string must precede each parameter in the script. The -p form is an abbreviation for the same parameter. You can use them interchangeably.

Note: The -param argument (without an "s" on the end) is not the same as the older -params parameter.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RunOnLaunch ~/Documents/appTests.suite/Scripts/test1.script -param "SUT1" -param "phonebook.txt"

Windows

"C:\Program Files\eggPlant\Eggplant.bat" -RunOnLaunch "C:\Users\Alex\Documents\MyTests.suite\scripts\test1.script" -param "SUT1" -param "phonebook.txt"

Linux

Eggplant -RunOnLaunch ~/Documents/appTests.suite/Scripts/test1.script -param "SUT1" -param "phonebook.txt"

-QuitAfterRun

Use: Invokes the given script or suite schedule, then quits Eggplant Functional. Valid values: yes/no. To cancel the quit, open Eggplant Functional, choose Eggplant from the main menu, then Quit. Then click the Cancel Quit button.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RunOnLaunch /Users/Alex/Docs.suite/Scripts/myTests/test2.script -QuitAfterRun yes

Windows

"C:\Program Files\Eggplant\Eggplant.bat" -RunOnLaunch "C:\Users\Alex\Documents\MySuite.suite\Scripts\test2.script" -QuitAfterRun yes

Linux

Eggplant -RunOnLaunch ~/Documents/appTests.suite/Scripts/test1.script ~/Documents/appTests.suite/Scripts/test2.script -QuitAfterRun yes

-ReopenDocuments

Use: Specifies whether to reopen the last open suites and scripts when you launch Eggplant Functional. Valid values: yes/no.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -ReopenDocuments no

Windows

"C:\Program Files\Eggplant\Eggplant.bat" -ReopenDocuments no

Linux

Eggplant -ReopenDocuments no
Note: This parameter overrides the Eggplant Functional General Preference for Reopen suites from last session.

-RestoreConnection

Use: Specifies whether to restore connections from the last session when you launch Eggplant Functional. Valid values: yes/no.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RestoreConnection yes

Windows

"C:\Program Files\Eggplant\Eggplant.bat" -RestoreConnection yes

Linux

Eggplant -RestoreConnection yes
Note: This parameter overrides the Eggplant Functional General Preference for Reopen connections from last session.

-RunOnLaunch

Use: Invokes the specified script(s) or suite schedule when you launch Eggplant Functional.

Examples:

Mac

/Applications/eggPlant.app/Contents/MacOS/Eggplant -RunOnLaunch /Users/Alex/Alex_Tests.suite/Schedule1

Windows

"C:\Program Files\Eggplant\Eggplant.bat" -RunOnLaunch "C:\Users\Alex\Documents\Eggplant\MySuite.suite\Schedule1"

Linux

Eggplant -RunOnLaunch ~/Documents/appTests.suite/scripts/test1.script

 

This topic was last updated on November 20, 2019, at 03:32:06 PM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2020 Eggplant