Skip to content

Commit

Permalink
Update README about new CLI and configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
ktos committed Oct 27, 2019
1 parent 4b07aad commit ec8ff36
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ analysis. Default is `false`.
* `-s` or `--runOnSet` -> starts a single run (like `-r`) but on provided list of
post ids, separated by commas, instead of getting new posts. You may use it like
`-s 1,2,3,4` to analyze posts of id values equal to 1, 2, 3 and 4. Implies `-r`.
* `--blacklist` -> comma separated list of forum ids, from which posts will be
ignored,
* `--ignoreAlreadyAnalyzed` -> ignores "already analyzed" database, analyzes
every post from not blacklisted forums, does not create "already analyzed"
database on exit,
* `--help` -> displays the help screen and exits,
* `--version` -> displays the version information and exists.

Expand Down Expand Up @@ -86,7 +91,8 @@ Possible configuration options are:
* `postComments` -> (bool) should post comments when unformatted code is found?,
* `timeBetweenUpdates` -> (int) what is the time sleeping before getting new batch of posts?,
* `threshold` -> (float) what is the threshold of "code" classification triggering posting a comment (by default: 0.99),
* `nagMessage` -> (string) what is the nag message posted as comment? `{0}` will be replaced with probability of unformatted code.
* `nagMessage` -> (string) what is the nag message posted as comment? `{0}` will be replaced with probability of unformatted code,
* `blacklist` -> (string) comma-separated list of forum ids from which posts will be ignored.

All these options may be used in a `appsettings.json` file in the current directory.
Apart from that, you may set verbosity level, by setting `Logging:LogLevel:Default`
Expand Down
6 changes: 6 additions & 0 deletions README.pl.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Dmyślnie `false`.
* `-s` lub `--runOnSet` -> uruchamia pojedynczą analizę, ale tylko na postach,
których id zostały przekazane w wartości polecenia (rozdzielone przecinkami).
Na przykład `-s 1,2` przeanalizuje posty o id 1 oraz 2. Implikuje `-r`.
* `--blacklist` -> oddzielana przecinkami lista identyfikatorów subforów, z
których posty będą ignorowane,
* `--ignoreAlreadyAnalyzed` -> ignoruje bazę danych już zanalizowanych postów,
nie tworzy jej przy wyjściu, nie ładuje przy uruchomieniu,
* `--help` -> wyświetla ekran pomocy i kończy działanie,
* `--version` -> wyświetla informacje o wersji i kończy działanie.

Expand Down Expand Up @@ -91,6 +95,8 @@ postów (w minutach)?,
oceniony jako zawierający problem? (domyślnie: 0.99),
* `nagMessage` -> (string) treść wiadomości która będzie wysłana w komentarzu
do posta zawierającego problem (`{0}` zostanie zamienione na prawdopodobieństwo).
* `blacklist` -> (string) oddzielana przecinkami lista identyfikatorów subforów
z których posty będą ignorowane.

Wszystkie te opcje mogą być ustawione w pliku `appsettings.json` w katalogu
roboczym. Poza tym, możliwe jest ustawienie poziomu logowania informacji, poprzez `Logging:LogLevel:Default` (dostępne wartości: `Debug`, `Information`, `Warning`
Expand Down

0 comments on commit ec8ff36

Please sign in to comment.