Update documentation
Add a section about common arguments for all subcommands. Closes #56.
This commit is contained in:
parent
b889d0e4f3
commit
bd1e1d2068
@ -42,6 +42,19 @@ The available commands are:
|
||||
in production.
|
||||
|
||||
|
||||
### Common arguments
|
||||
|
||||
You can pass some command-line arguments to Flatisfy commands, common to all the available commands. These are
|
||||
|
||||
* `--help`/`-h` to get some help message about the current command.
|
||||
* `--data-dir DIR` to overload the `data_directory` value from config.
|
||||
* `--config CONFIG` to use the config file located at `CONFIG`.
|
||||
* `--passes [0, 1, 2, 3]` to overload the `passes` value from config.
|
||||
* `--max-entries N` to overload the `max_entries` value from config.
|
||||
* `-v` to enable verbose output.
|
||||
* `-vv` to enable debug output.
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
List of configuration options:
|
||||
|
Loading…
Reference in New Issue
Block a user