phyks/flatisfy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update documentation

Browse Source 
Add a section about common arguments for all subcommands. Closes #56.
This commit is contained in:
Lucas Verney 2017-06-14 10:46:38 +02:00
parent b889d0e4f3
commit bd1e1d2068
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/0.getting_started.md
View File

@ -42,6 +42,19 @@ The available commands are:
in production. 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 ## Configuration
List of configuration options: List of configuration options: