From 9b40c5a67525df810d039f49f340a4662c7aca20 Mon Sep 17 00:00:00 2001
From: Luc Didry <luc@didry.org>
Date: Thu, 29 Aug 2024 17:19:06 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20=E2=80=94=20Document=20test-mail?=
 =?UTF-8?q?=20command?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/cli.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/cli.md b/docs/cli.md
index 83a98f3..67a660d 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -85,6 +85,7 @@ Commands:
   migrate          Run database migrations
   reload-config    Load or reload tasks’ configuration
   start            Starts the server (use only for testing or development!)
+  test-mail        Send a test email
   user             User management
   watch-agents     Watch agents (to run routinely)
 ```
@@ -465,3 +466,28 @@ Options:
 
 <!--[[[end]]]
 -->
+
+#### Test the email settings
+
+You can verify that your mail settings are ok by sending a test email
+
+<!--
+.. [[[cog
+    help(["server", "test-mail", "--help"])
+.. ]]] -->
+
+```man
+Usage: argos server test-mail [OPTIONS]
+
+  Send a test email
+
+Options:
+  --config TEXT    Path of the configuration file. If ARGOS_YAML_FILE
+                   environment variable is set, its value will be used instead.
+  --domain TEXT    Domain for the notification
+  --severity TEXT  Severity
+  --help           Show this message and exit.
+```
+
+<!--[[[end]]]
+-->