From 89aa74afdeacd6575d5f47c4af519fe555d81d77 Mon Sep 17 00:00:00 2001 From: mbsantiago Date: Mon, 22 Jun 2026 21:31:09 -0600 Subject: [PATCH] docs: clarify CLI log file option --- docs/source/reference/cli/index.md | 2 ++ .../source/tutorials/run-inference-on-folder.md | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/docs/source/reference/cli/index.md b/docs/source/reference/cli/index.md index e4d931e..8c79c26 100644 --- a/docs/source/reference/cli/index.md +++ b/docs/source/reference/cli/index.md @@ -17,6 +17,8 @@ for the full option list. ## Notes - Global CLI options are documented in {doc}`base`. +- Use `--log-file path/to/cli.log` to save CLI logs to a file while still + showing them in the terminal. - Paths with spaces should be wrapped in quotes. - Input audio is expected to be mono. - `process` uses the optional `--detection-threshold` override. diff --git a/docs/source/tutorials/run-inference-on-folder.md b/docs/source/tutorials/run-inference-on-folder.md index 48f647c..6056a11 100644 --- a/docs/source/tutorials/run-inference-on-folder.md +++ b/docs/source/tutorials/run-inference-on-folder.md @@ -97,6 +97,23 @@ What this does: - runs the model on each recording, - saves the results in `path/to/outputs`. +```{eval-rst} +.. admonition:: Save CLI logs to a file + :collapsible: closed + :class: tip dropdown + + If you want to keep a copy of the CLI logs, add ``--log-file`` before the + subcommand: + + .. code-block:: bash + + batdetect2 --log-file path/to/cli.log process directory \ + path/to/audio \ + path/to/outputs + + This writes the same CLI logs to ``path/to/cli.log`` and to the terminal. +``` + You do not need to choose a model for this first run. If you do nothing, BatDetect2 uses the built-in default UK model.