docs : Update cli documentation (#3102)

* docs : Update cli documentation

This updates the documentation of cli based on the actual output

In the longterm this should ideally be auto generated to prevent mismatch

* docs : Update cli documentation

This updates the documentation of cli based on the actual output

In the longterm this should ideally be auto generated to prevent mismatch

diff --git a/examples/cli/README.md b/examples/cli/README.md
index 1847134efb1cb84dba3bf4320f4d74ddb476c0a1..65285c3cb66d530ee3c6240a31883c58501d4116 100644 (file)
--- a/examples/cli/README.md
+++ b/examples/cli/README.md
@@ -6,7 +6,8 @@ It can be used as a reference for using the `whisper.cpp` library in other proje
 ```\r
 ./build/bin/whisper-cli -h\r
 \r
-usage: ./build-pkg/bin/whisper-cli [options] file0.wav file1.wav ...\r
+usage: ./build/bin/whisper-cli [options] file0 file1 ...\r
+supported audio formats: flac, mp3, ogg, wav\r
 \r
 options:\r
   -h,        --help              [default] show this help message and exit\r
@@ -24,6 +25,7 @@ options:
   -wt N,     --word-thold N      [0.01   ] word timestamp probability threshold\r
   -et N,     --entropy-thold N   [2.40   ] entropy threshold for decoder fail\r
   -lpt N,    --logprob-thold N   [-1.00  ] log probability threshold for decoder fail\r
+  -nth N,    --no-speech-thold N [0.60   ] no speech threshold\r
   -tp,       --temperature N     [0.00   ] The sampling temperature, between 0 and 1\r
   -tpi,      --temperature-inc N [0.20   ] The increment of temperature, between 0 and 1\r
   -debug,    --debug-mode        [false  ] enable debug mode (eg. dump log_mel)\r
@@ -50,12 +52,13 @@ options:
   -dl,       --detect-language   [false  ] exit after automatically detecting language\r
              --prompt PROMPT     [       ] initial prompt (max n_text_ctx/2 tokens)\r
   -m FNAME,  --model FNAME       [models/ggml-base.en.bin] model path\r
-  -f FNAME,  --file FNAME        [       ] input WAV file path\r
+  -f FNAME,  --file FNAME        [       ] input audio file path\r
   -oved D,   --ov-e-device DNAME [CPU    ] the OpenVINO device used for encode inference\r
   -dtw MODEL --dtw MODEL         [       ] compute token-level timestamps\r
   -ls,       --log-score         [false  ] log best decoder scores of tokens\r
   -ng,       --no-gpu            [false  ] disable GPU\r
   -fa,       --flash-attn        [false  ] flash attention\r
+  -sns,      --suppress-nst      [false  ] suppress non-speech tokens\r
   --suppress-regex REGEX         [       ] regular expression matching tokens to suppress\r
   --grammar GRAMMAR              [       ] GBNF grammar to guide decoding\r
   --grammar-rule RULE            [       ] top-level GBNF grammar rule name\r