help command

The --help command lists all the available Liquibase commands, required and optional parameters, and changelog property. The command also presents Liquibase Hub commands— registerChangeLog, syncHub, and the hubAPIKey property with the definitions.

Uses

The --help command is typically used to check the syntax of commands, their definitions, and parameters. The command provides the output that includes the following:

  • Standard commands
  • Diff commands
  • Documentation commands
  • Maintenance commands
  • Hub commands
  • Required parameters
  • Optional parameters
  • Required diff parameters
  • Optional diff parameters
  • changelog properties
  • Hub integration CLI parameter

Running the --help command

To run the --help command, enter the following on your command line:

liquibase --help