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: + +#### Test the email settings + +You can verify that your mail settings are ok by sending a test email + + + +```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. +``` + +