moto-0.0.4: lib/cli_help.docs

{- $cli_help

This is the full description of the command line options supported by
'Moto.getOpts', using @Moto.File.fileRegistry@ as the registry.

Main program (here called @moto-example@):

@
Usage: moto-example COMMAND
  Command line interface to migrations.

Available options:
  -h,--help                Show this help text

Available commands:
  run                      Run migrations.
  show-migrations          Show available migrations.
  check-migrations         Exit immediately with status 0 if the available
                           migrations are compatible with the registry.
                           Otherwise, exit with status 1.
  show-registry            Show migrations registry.
  clean-registry           Clean a dirty migrations registry.
  delete-recovery-data     Delete contents from the migrations data store.
@



Subcommand @run@:

@
Usage: moto-example run --registry SETTINGS [--backwards] [--mig ID]
                        [--no-dry-run]
  Run migrations.

Available options:
  --registry SETTINGS      File where registry file is stored. E.g.,
                           \/var\/db\/migrations
  --mig ID                 If specified, only consider running the migration
                           identified by this ID. Use multiple times for
                           multiple migrations.
  --no-dry-run             Don't just show the execution plan, run it!
  -h,--help                Show this help text
@



Subcommand @show-migrations@:

@
Usage: moto-example show-migrations [--dot]
  Show available migrations.

Available options:
  --dot                    Render graph in DOT (Graphviz) format.
  -h,--help                Show this help text
@



Subcommand @check-migrations@:

@
Usage: moto-example check-migrations --registry SETTINGS
  Exit immediately with status 0 if the available migrations are compatible with
  the registry. Otherwise, exit with status 1.

Available options:
  --registry SETTINGS      File where registry file is stored. E.g.,
                           \/var\/db\/migrations
  -h,--help                Show this help text
@



Subcommand @show-registry@:

@
Usage: moto-example show-registry --registry SETTINGS
  Show migrations registry.

Available options:
  --registry SETTINGS      File where registry file is stored. E.g.,
                           \/var\/db\/migrations
  -h,--help                Show this help text
@



Subcommand @clean-registry@:

@
Usage: moto-example clean-registry --registry SETTINGS [--dry-run]
                                   ([--unsafe-abort] | [--unsafe-commit])
  Clean a dirty migrations registry.

Available options:
  --registry SETTINGS      File where registry file is stored. E.g.,
                           \/var\/db\/migrations
  --dry-run                Don't clean registry, just show whether it is clean
                           and exit immediately with status 0 if so, otherwise
                           exit with status 1.
  --unsafe-abort           If the registry is dirty, unsafely abort the pending
                           migration without performing any actual clean-up.
  --unsafe-commit          If the registry is dirty, unsafely commit the pending
                           migration without performing any actual clean-up.
  -h,--help                Show this help text
@



Subcommand @delete-recovery-data@:

@
Usage: moto-example delete-recovery-data --mig ARG
  Delete contents from the migrations data store.

Available options:
  -h,--help                Show this help text
@
-}