Using the Command Line

From AppWave
Jump to: navigation, search

Go Up to Using AppWave Studio


The AppWavec.exe command line tool exposes Studio related functionality. Basic usage details can be found by running the tool without any parameters.

Note: In order to use this option the user must open a window to a command prompt, CMD. Its location depends on the Operating System:

  • Windows 7 or 8: C:\ProgramData\Embarcadero\AppWaveBrowser
  • Windows XP: C:\Documents and Settings\All Users\Application Data\Embarcadero\AppWaveBrowser

The available options are:

Option Description
AppWavec -A Lists all supported functionality.
AppWavec -B Broadcast file(s) to an AppWave. Used to send files to a host. The files can be an app, a template(.aw) or a new pade plugin.
AppWavec -C Converts an Endeavors Studio project file (.stw) into a Studio project file (.tca).
AppWavec -CE Converts a Studio project file (.tca) into an Endeavors Studio project file (.stw).
AppWavec -F Copy files and folders included on a project file (.tca) to a new location.
AppWavec -Ma Create a stp file from a tca file. This option just uses recorder library from appvirt to create a stp file (that is a zip that contains virtualization files).
AppWavec -PPL Creates .pade from a plugin.
AppWavec -X Creates a new app file from .tca and .stp files.

AppWavec -A

AppWavec -A Lists all the command line options available and detailed information for each.

AppWavec.png

AppWavec -B

AppWavec -B The -B or -Broadcast option broadcasts to an AppWave one of four different ways:

  • Usage 1: Broadcast a project (Studio and STP files are required) AppWavec (-B|-Broadcast) (-T|-StudioFile) <myProduct .tca> -STP <myProduct .stp> -URL <AppWave> -U [<domain>\]<user> [-PWD <password>] [-EDN] [-Debug]
  • Usage 2: An .app file. Broadcast an app (.app file is required) AppWavec (-B|-Broadcast) -APP <myProduct .app> -URL <AppWave> -U [<domain>\]<user> [-PWD <password>] [-EDN] [-Debug]
  • Usage 3: Broadcast PADE plugins (.pade files) AppWavec (-B|-Broadcast) -PADE <myPlugin .pade> -URL <AppWave> -U [<domain>\]<user> [-PWD <password>] [-EDN] [-Debug]
  • Usage 4: Broadcast AppWave templates (*.aw files) AppWavec (-B|-Broadcast) -AW <myAppWave .aw> -URL <AppWave> -U [<domain>\]<user> [-PWD <password>] [-EDN] [-Debug]
Argument Description
-B or -Broadcast Selects the broadcast option.
-T or -StudioFile The full path and file name of myProduct's .TCA file.
-STP The full path and file name of myProduct's .STP file (created during mastering).
-APP Full path and file name of the mastered myProduct's .APP file.
-PADE Full path and file name of the mastered plugin's .PADE file.
-AW Full path and file name of the AppWave file to be broadcast.
-URL The AppWave server URL.
-U or -UserName The UserName for the AppWave server.
-PWD The password for the user (optional).
-EDN Login with public\Embarcadero Developers Network account.
-Debug To output debug messages.
myProduct .tca The full path and filename of your product's Studio file.
myProduct .stp Full path to the STP file created when mastering myProduct.
myProduct .app Full path to the APP file created when broadcasting myProduct.
myPlugin .pade Full path to the PADE (mastered plugin) file.
AppWave The AppWave server URL.
user The username or domain\username for the AppWave login.
password The password for the AppWave.

AppWavec -C

AppWavec -C Convert an endeavors studio project file (.stw) into a Studio project file (.tca) Usage: AppWavec <-C|-Convert> -S <file + .stw> -O <outputLocation> -N <outputName> [-Debug]

Argument Description
-C or -Convert Selects the convert option.
-S or -SourceFile The full path and file name of .stw file to convert.
-O or -Out The full path to the output location directory.
-N or -Name The output file name. Do not include an extension
-Debug To output debug messages.
file.stw The full path and filename of the STW.
outputLocation The directory where the .tca file is output. A complete drive and directory name is required.
outputName The filename for the .tca file produced. This argument is just the name without any file extension.

AppWavec -CE

AppWavec -CE Convert a Studio project file (.tca) inro an endeavors studio project file (.stw) Usage: AppWavec <-CE|-ConvertAppVirt> -S <file + .tca> -O <outputLocation> -N <outputName> [-Debug]

Argument Description
-CE or -ConvertAppVirt Selects the convert option.
-S or -SourceFile The full path and file name of the .tca file to convert.
-O or -Out The full path to the output location directory.
-N or -Name The output file name. Do not include an extension
-Debug To output debug messages.
file.stw The full path and file name of the STW.
outputLocation The directory where the .stw file is output. A complete drive and directory name is required.
outputName The file name for the .stw file produced. This argument is just the name without any file extension.

AppWavec -F

AppWavec -F Copy files and folders included on a project file (.tca) to a new location. Usage: AppWavec <-F|-CopyFiles> -T <template.tca> -O <outputLocation>

Argument Description
-F or -CopyFiles Selects the Copy Files option.
-T or -StudioFile The full path and file name of the template Studio file.
-O or -Out The file output directory.
-Debug To output debug messages.
template.tca The full path and filename of the template Studio file.
outputLocation The full path of the directory to save to.

AppWavec -Ma

AppWavec -Ma This option masters an App. All files referenced in the template.tca must exist. The template.tca file must be a complete, valid studio file with all required data.or mastering will fail. Mastering creates an App: OutputName.stp file. All listed arguments are required except -Debug. The outputName argument is used as a name for the .stp file, so there should be not files named OutputName.stp in the OutputLocation directory. If the output directory does not exist, it will be created. Usage: AppWavec <-Ma|-Master> -T <template.tca> -O <outputLocation> -U <user> -N <outputName> [Debug]

Argument Description
-Ma or -Master Selects the mastering option
-T or -StudioFile The template Studio file.
-O or -Out The full path of the output location directory.
-N or -Name The file output name.
-U or -Username The User name.
-Debug To output debug messages.
template.tca The full path and filename of the template Studio file.
outputLocation The full path of the directory to save to.
outputName The name for all artifacts created. Do not include an extension.

AppWavec -PPL

AppWavec -PPL This creates pade from a plugin: The -PPL option masters the files of a PADE plugin into a PADE file. It requires the path to the folder containing the plugin files. Two files must be included: the version .dat and the main plugin file that has the same name as the plugin. Optionally additional files may be included. Only the files listed in version .dat will be included in the PADE file. Usage: AppWavec -PPL <-PL|-Plugin> <fullPathToPlugInFolder> [<-O|-Out) <outputLocation> ] [-Debug]

Argument Description
-PPL Selects the master plugin option.
-PL or -Plugin The full path to the folder containing the plugin files.
-O or -Out The full path of the output location directory.

AppWavec -X

AppWavec -X Extract: This option exports an app file (creates an APP file from a Studio/STP file combination). The Studio file (.tca) has to be the file used to generate the STP file. Usage: Create *.app file from TCA and STP: AppWavec (-X|-Export) -T <myProduct .tca> -STP <myProduct .stp> -O <outputLocation> -N <outputName> [-Debug]

Argument Description
-X or -Export Selects the export option.
-T or -StudioFile The full path and file name of the template Studio file.
-STP The full path and file name of the mastered App.
-O or -Out The file output directory.
-N or -Name The output file name.
-Debug To output debug messages.
myProduct .tca The full path and filename of the template Studio file.
myProduct .stp The full path and filename of the app file to be broadcast.
outputLocation The full path of the directory to save to.
outputName The name of the app file to create.

See Also