To get a list of possible configuration options, simply run gh-ost --help
locally and convert the hyphenated args to be underscored. There are a few args that are not accepted:
alter
=> this is required and will be set automatically based on the output of your migrationtable
=> same story asalter
help
=> this wouldn't be usefulversion
=> also wouldn't be usefulask-pass
=> at the moment we only support thepassword
flag (so we don't have to deal with accepting input mid-migration)
You can use ERB templates to get dynamic values for your configuration. Read more here: Templating
- For boolean args (that do not require a value in the command line), set them as
true
/false
and they will be either included or excluded accordingly. - There is not (yet!) any type checking on the arguments, so it's up to you to know what values should be expected (run
gh-ost --help
for assistance)