Working from the Command Line | Extension Manager CS6

Otsi

In CS4 and later, you can use the command line to perform various operations you would normally perform in the Extension Manager workspace.

Extension Manager command-line basics

You can manage extensions from the command line, using certain syntax, commands, and attributes.

  1. In Windows, open the command prompt by selecting Start > All Programs > Accessories > Command Prompt. In Mac OS, open Terminal by double-clicking its icon in the Applications/Utilities folder.

  2. Navigate to the following folder:

    • Windows: C:\Program Files\Adobe\Adobe Extension Manager CSx\
    • Mac OS: /Applications/Adobe Extension Manager CSx/Adobe Extension Manager CSx.app/Contents/MacOS

    where CSx is the Extension Manager version number, such as CS6.

  3. On the command line, enter the executable as follows (including the double quotes):
    • Windows (CS5 and later): XManCommand.exe
    • Windows (CS4): "Adobe Extension Manager CS4.exe"
    • Mac OS: “./Adobe Extension Manager CSx”

    where CSx is the Extension Manager version number, such as CS6.

  4. After the executable, enter the desired command.

    The following list describes the available commands:

    -package

    Package an extension. Required attributes: mxi, and mxp (CS5.5 and earlier) or zxp.

    -install

    Install an extension. Required attribute: mxp or zxp. Optional attributes: suppresseula (CS5.5 and later), forallusers (CS6 and later), and timeout (CS5 and later).

    -remove

    Remove an extension. Required attributes: product, extension. Optional attribute (CS5 and later): timeout.

    -enable

    Enable an extension. Required attributes: product, extension. Optional attribute (CS5 and later): timeout.

    -disable

    Disable an extension. Required attributes: product, extension. Optional attribute (CS5 and later): timeout.

    -activate

    (CS6 and later) Activate a set for a point product. Required attribute: product, set.

    -import

    (CS6 and later) Import set configuration from a XML file. Required attribute: setcfg.

    -convert

    (CS6 and later) Convert mxp extension to zxp extension. Required attributes: mxp and zxp.

    -locate

    Locate the point product in the Extension Manager workspace. Required attribute: product.

    -from

    (CS5 and later) Specifies the command originator when the command line parameter is passed through BridgeTalk. After executing the command, Extension Manager sends the result back to the specified originator. Required attributes: product or pcdentry.

    -EMBT

    Used only when the command line parameter is passed through BridgeTalk. "-EMBT" should appear before all other commands. Attributes: None.

    -suppress

    Suppress the Extension Manager user interface. Must precede all the other commands except -EMBT. Attributes: None.

    -locale

    Specify a locale for Extension Manager at startup. Required attribute: lang.

    -quit

    (CS5 and later) Quit Extension Manager. This command should be used alone.

    The following list describes the available attributes:

    mxi

    Specifies the name and location of the extension installation file.

    mxp

    Specifies the name and location of the package file in MXP format.

    zxp

    Specifies the name and location of the package file in ZXP format.

    product

    Specifies the product that uses the extension. The value should be the same as the product name displayed in the left panel of Extension Manager window.

    extension

    Specifies the name of the extension (as specified in the MXI file).

    pcdentry

    (CS5 and later) Specifies the BridgeTalk identifier of command originator.

    suppresseula

    (CS5.5 and later) Specifies whether to suppress the EULA dialog box when installing the extension. The valid values are “y” (suppress) or “n” (do not suppress). The default value is “n”.

    forallusers

    (CS6 and later) Specifies that the extension should be installed for all users if the value is "y" and the extension is a per-user extension. A per-user extension is a kind of extension whose files are copied to user-specific folders during installation. The default value is "n".

    lang

    Specifies the locale language code, such as en_US.

    timeout

    (CS5 and later) Specify the maximum seconds the Extension Manager waits for the product to quit before executing the next command. Must follow the install/enable/disable/remove commands, and must be a positive integer from 0 through 1000.

    set

    (CS6 and later) Specifies the set name to be activated.

    setcfg

    (CS6 or later) Specifies the name and location of the exported set configuration file.

Package an extension from the command line

  1. Navigate to the Extension Manager application folder.
  2. (Windows) Enter the following command, specifying your own attribute values:
    • (CS4): "Adobe Extension Manager CS4.exe" -package mxi="c:\myfile.mxi" mxp="c:\myfile.mxp"
    • (CS5 and CS5.5, MXP format): "XManCommand.exe" -package mxi="c:\myfile.mxi" mxp="c:\myfile.mxp"
    • (CS5 and later, ZXP format): "XManCommand.exe" -package mxi="c:\myfile.mxi" zxp="c:\myfile.zxp"
  3. (Macintosh) Enter the following command, specifying your own attribute values:
    • (CS4/CS5/CS5.5, MXP format): "./Adobe Extension Manager CSx" -package mxi="/myfolder/mysubfolder/myfile.mxi" mxp="/myfolder/mysubfolder/myfile.mxp"
    • (CS5 and later, ZXP format): "./Adobe Extension Manager CSx" -package mxi="/myfolder/mysubfolder/myfile.mxi" zxp="/myfolder/mysubfolder/myfile.zxp"
  4. Install and test the extension to make sure that everything works as intended.

Install an extension from the command line

  1. Navigate to the Extension Manager application folder.
  2. (Windows) Enter the following command, specifying your own attribute value:
    • (CS4): "Adobe Extension Manager CS4.exe" -install mxp="c:\myfile.mxp"
    • (CS5 and later, MXP format): "XManCommand.exe" -install mxp="c:\myfile.mxp"
    • (CS5 and later, ZXP format): "XManCommand.exe" -install zxp="c:\myfile.zxp"
  3. (Macintosh) Enter the following command, specifying your own attribute value:
    • (MXP format): "./Adobe Extension Manager CSx" -install mxp="/myfolder/mysubfolder/myfile.mxp"
    • (ZXP format): "./Adobe Extension Manager CSx" -install zxp="/myfolder/mysubfolder/myfile.zxp"
  4. To suppress the Extension Manager user interface, add the suppress command before the install command, as follows:
    ... -suppress -install zxp="c:\myfile.zxp"
  5. To specify a locale, add the locale command and specify the lang attribute before the install command, as follows:
    ... -locale lang="en_US" -install zxp="c:\myfile.zxp"
  6. Test the extension to make sure that everything works as intended.

Remove an extension from the command line

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute values:
    • (Windows, CS5 and later): XManCommand.exe -remove product="Dreamweaver CSx" extension="Sample"
    • (Windows, CS4) "Adobe Extension Manager CS4.exe" -remove product="Dreamweaver CS4" extension="Sample"
    • (Macintosh): "./Adobe Extension Manager CSx" -remove product="Dreamweaver CSx" extension="Sample"

    where CSx is the Extension Manager version number, such as CS6.

    Use the product attribute to specify the product that uses the extension. Use the extension attribute to specify the name of the extension.

Enable an extension from the command line

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute values:
    • (Windows, CS5 and later): XManCommand.exe -enable product="Dreamweaver CSx" extension="Sample"
    • (Windows, CS4): "Adobe Extension Manager CS4.exe" -enable product="Dreamweaver CS4" extension="Sample"
    • (Macintosh): "./Adobe Extension Manager CSx" -enable product="Dreamweaver CSx" extension="Sample"

    where CSx is the Extension Manager version number, such as CS6.

    Use the product attribute to specify the product that uses the extension. Use the extension attribute to specify the name of the extension.

Disable an extension from the command line

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute values:
    • (Windows, CS5 and later): XManCommand.exe -disable product="Dreamweaver CSx" extension="Sample"
    • (Windows, CS4): "Adobe Extension Manager CS4.exe" -disable product="Dreamweaver CS4" extension="Sample"
    • (Macintosh): "./Adobe Extension Manager CSx" -disable product="Dreamweaver CSx" extension="Sample"

    where CSx is the Extension Manager version number, such as CS6.

    Use the product attribute to specify the product that uses the extension to be disabled. Use the extension attribute to specify the name of the extension.

Locate the point product in the Extension Manager workspace

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute value:
    • (Windows, CS5 and later): XManCommand.exe -locate product="Dreamweaver CSx"
    • (Windows, CS4): "Adobe Extension Manager CS4.exe" -locate product="Dreamweaver CS4"
    • (Macintosh): "./Adobe Extension Manager CSx" -locate product="Dreamweaver CSx"

    where CSx is the Extension Manager version number, such as CS6.

    Use the product attribute to specify the product to locate.

Convert an MXP extension to a ZXP extension from the command line (CS6 and later)

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute values:
    • Windows: XManCommand.exe -convert mxp="c:\myOldExtension.mxp" zxp=”c:\myNewExtension.zxp"
    • Mac OS: "./AdobeExtension Manager CS6" -convert mxp="/myfolder/mysubfolder/myOldExtension.mxp" zxp="/myfolder/mysubfolder/myNewExtension.zxp"

Use the mxp attribute to specify the MXP extension to convert. Use the zxp attribute to specify the path and name of the new ZXP extension.

Activate an extension set from the command line (CS6 and later)

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute value:
    • Windows: XManCommand.exe -activate product="Dreamweaver CS6" set="Adobe Extensions"
    • Mac OS: "./Adobe Extension Manager CS6" -activate product="Dreamweaver CS6" set="Adobe Extensions"

Use the product attribute to specify the product to activate the extension set. Use the set attribute to specify the name of the extension set to activate.

Import a set configuration from the command line (CS6 and later)

  1. Navigate to the Extension Manager application folder.
  2. Enter the following command, specifying your own attribute value:
    • Windows: XManCommand.exe -import setcfg="c:\SetConfig.xml"
    • Mac OS: "./Adobe Extension Manager CS6" -import setcfg="/myfolder/mysubfolder/SetConfig.xml"

Use the setcfg attribute to specify the path and name of the set configuration file to import.

Execute commands through BridgeTalk

Extension Manager can execute commands passed through BridgeTalk. All commands sent through BridgeTalk must begin with "-EMBT" parameter. To send commands to the Extension Manager, specify the target BridgeTalk Identifier as "exman-6.0".

Run the example script below in ExtendScript Toolkit CS6 to send a package command to Extension Manager through BridgeTalk.

Windows:
 
var bt = new BridgeTalk();
bt.target = "exman-6.0";
bt.body = '-EMBT -package mxi="C:\\test.mxi" zxp="C:\\test.zxp"';
bt.send();
Mac OS:
 
var bt = new BridgeTalk();
bt.target = "exman-6.0";
bt.body = '-EMBT -package mxi="/Volumes/x1/test.mxi" zxp="/Volumes/x1/test.zxp"';
bt.send();

Return codes after executing commands

Extension Manager provides return codes after executing commands when one of the following two parameters is included in the command:

  • "-suppress" (the Extension Manager user interface is not displayed when the command is executed)
  • "-from"

After executing the command, Extension Manager returns one of the following return codes:

0 - Command succeeded

1 - Install extension failed

2 - Remove extension failed

3 - Enable extension failed

4 - Disable extension failed

5 - Package extension failed

6 - Activate extension set failed

7 - There is already an instance of Extension Manager

8 - Import set configuration failed

101 - Incorrect CLI format

102 - The specified product does not exist

103 - The specified extension does not exist

104 - The specified extension is already enabled

105 - The specified extension is already disabled

106 - The specified extension set does not exist

107 - The specified set configuration file does not exist

108 - The specified set configuration file is invalid

109 - The specified extension cannot be enabled or disabled when the active extension set is a pre-defined extension set

Note: If the command execution requires administrative privileges and the current permission is insufficient, Extension Manager CS5.5 and later asks for administrator credentials when the user interface is not suppressed. When the user interface is suppressed (when the "-suppress" parameter is specified), the execution fails. In this case, open the command prompt as administrator (Windows) or use the sudo command in the Terminal window (Macintosh).

Adobe logo

Logige oma kontole sisse

Kiirlingid

Vaadake kõiki oma plaane Plaanide haldamine

Legal Notices    |    Online Privacy Policy