Generate and publish output from the command prompt

Command-line generation publishes layouts without opening RoboHelp, or automatically in a scheduled batch. Command-line and batch generation and publishing can occur simultaneously.

Note: To access the command prompt from within RoboHelp, click Start > Programs > Adobe RoboHelp [version]> Tools > RoboHelp Command Prompt.

Open the application from the command prompt

  1. At the command prompt, enter the command in the following format:

    rhcl myproject\myproject.xpj
  2. Access the output files in the default output folder.

Generate layouts from the command prompt

  • To generate a single layout to the default output folder (!SSL!), enter the command in the following format:

    rhcl [project path] [-l] [layout name]
  • To generate a single layout to a custom output folder, enter the command in the following format:

    rhcl [project path] [-l] [layout name] [-o] [path of custom output folder]
  • To generate all layouts to the default output folder (!SSL!), enter the command in the following format:

    rhcl [project installation path] [-b]
  • To generate all layouts to a custom output folder, enter the command in the following format:

    rhcl [full or relative path of the RoboHelp project] [-b]

Publish layouts from the command prompt

 Enter the command in the following format:
rhcl [project path] [-p] [server name][user name][password]

The server name, user name, and password are optional.

Command prompt options

Commands must start with rhcl and include the project path and name. Enter commands using the following format:

rhcl [-?] [-h] [project path] [-l] [layout name] [-p] [server name:user name:password] [-o] [output folder path] [-d] [-b] [-g]

Not all options are required when entering a command.

-l
Generates a layout. Specify the layout name (for example, -l FlashHelp). The application generates the primary layout if a layout is not specified.

-p
Publishes a layout. Configure all publishing destinations using the New Destination dialog box.

Indicates spaces.

-o
Sends the output to a folder.

-d
Displays layout and publishing destination names at the command prompt.

-b
Generates the layouts set for batch generation. Outputs to the output folder for a particular single-source layout.

-h
Displays Help.
  • rhcl

  • rhcl -h

  • rhcl -?

-g
Specifies a log filename.

If you specify this option with the rhcl command, rhcl writes the output into the specified log file. The output is not sent to the console. The specified log filename cannot contain Unicode characters. If a file by this name exists, that file is overwritten.