From 415e9e23c6fae5208374bcd6c5a5d956ba142b6e Mon Sep 17 00:00:00 2001
From: vmalefioudakis <benmalef@hotmail.com>
Date: Sun, 10 Nov 2024 12:57:12 +0200
Subject: [PATCH] add doc for --log-file

---
 docs/usage.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/usage.md b/docs/usage.md
index 1f56947c9..a3d7f0278 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -176,6 +176,14 @@ To split the data CSV into training, validation, and testing CSVs, the `gandlf s
   -o $output_dir # the output directory to save the split data
 ```
 
+### Using the `--log-file` parameter
+By default, only the `info` and `error` logs will be **displayed** in the console and
+the log file will be **saved** in `$(home)/.gandlf/<timestamp>.log`.
+
+Also, you can use the `--log-file` and provide the file that you want to save the logs
+```bash
+(venv_gandlf) $> gandlf <command> --log-file <log_file_path>
+```
 
 ## Customize the Training