From 8e9166f4eba18ceafb82f95ebde7d552f576dc82 Mon Sep 17 00:00:00 2001
From: Thibault Le Ouay <thibaultleouay@gmail.com>
Date: Sun, 20 Jul 2025 14:28:39 +0200
Subject: [PATCH] improve doc

---
 internal/run/run.go | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/internal/run/run.go b/internal/run/run.go
index 8752072..48af7bc 100644
--- a/internal/run/run.go
+++ b/internal/run/run.go
@@ -120,7 +120,15 @@ func RunCmd() *cli.Command {
 		Aliases:     []string{"r"},
 		Usage:       "Run your synthetics tests",
 		UsageText:   "openstatus run [options]",
-		Description: "Run the synthetic tests defined in the config.openstatus.yaml",
+		Description: `Run the synthetic tests defined in the config.openstatus.yaml.
+The config file should be in the following format:
+
+tests:
+  ids:
+     - monitor-id-1
+     - monitor-id-2
+
+     `,
 		Action: func(ctx context.Context, cmd *cli.Command) error {
 
 			path := cmd.String("config")
-- 
knotmirror 0.0.1