From 4f2c4bf655a230813bc757d5a16b86514688b930 Mon Sep 17 00:00:00 2001
From: gavin913427-hash <gavin913427-hash@users.noreply.github.com>
Date: Mon, 4 May 2026 23:18:06 +0800
Subject: [PATCH] fix: add format hint to --param flag description (fixes
 #1977)

---
 .changeset/fix-param-flag-description.md            | 5 +++++
 src/apps/cli/internal/flags/generate/sharedFlags.ts | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/fix-param-flag-description.md

diff --git a/.changeset/fix-param-flag-description.md b/.changeset/fix-param-flag-description.md
new file mode 100644
index 000000000..a6c849e24
--- /dev/null
+++ b/.changeset/fix-param-flag-description.md
@@ -0,0 +1,5 @@
+---
+"@asyncapi/cli": patch
+---
+
+Add format hint to --param flag description for better UX (fixes #1977)
diff --git a/src/apps/cli/internal/flags/generate/sharedFlags.ts b/src/apps/cli/internal/flags/generate/sharedFlags.ts
index b08f5dfc6..cb93bef2d 100644
--- a/src/apps/cli/internal/flags/generate/sharedFlags.ts
+++ b/src/apps/cli/internal/flags/generate/sharedFlags.ts
@@ -38,7 +38,7 @@ export const sharedFlags = {
   ),
   param: Flags.string({
     char: 'p',
-    description: 'Additional param to pass to templates',
+    description: 'Additional param to pass to templates (format: name=value)',
     multiple: true
   }),
   'map-base-url': Flags.string({