Improved help content.

Skedulo · Jun 15, 2021 · 6e94729 · 6e94729
1 parent 19c8758
commit 6e94729
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 4 deletions.
diff --git a/src/commands/integrations.ts b/src/commands/integrations.ts
@@ -118,8 +118,8 @@ const command: ICommandDesc = {
         integrationsDisableCommand,
     ],
     help: {
-        usage: "opsgenie integrations",
-        description: "Prints open Opsgenie integrations to the terminal.",
+        usage: "opsgenie integrations [<command>]",
+        description: "Prints open Opsgenie integrations to the terminal. By default this command lists integrations.",
     },
 };
 

diff --git a/src/commands/integrations/disable.ts b/src/commands/integrations/disable.ts
@@ -105,7 +105,25 @@ const command: ICommandDesc = {
     constructor: IntegrationsDisableCommand,
     help: {
         usage: "opsgenie integrations disable [options]",
-        description: "Prints open Opsgenie integrations to the terminal.",
+        description: "Disables Opsgenie integrations by id, name or regular expression",
+        options: [
+            {
+                name: "--id=<id>",
+                description: "Sets the id of the integration to disable."
+            },
+            {
+                name: "--id=<name>",
+                description: "Sets the name of the integration to disable."
+            },
+            {
+                name: "--regex=<regex>",
+                description: "Disable integrations by matching name against the regular expression.",
+            },
+            {
+                name: "--dry-run",
+                description: "Prints the names of integrations that would be affected, but doesn't actually make any changes.",
+            },
+        ],
     },
 };
 

diff --git a/src/commands/integrations/enable.ts b/src/commands/integrations/enable.ts
@@ -106,7 +106,25 @@ const command: ICommandDesc = {
     constructor: IntegrationsEnableCommand,
     help: {
         usage: "opsgenie integrations enable [options]",
-        description: "Enables Opsgenie integrations.",
+        description: "Enables Opsgenie integrations by id, name or regular expression",
+        options: [
+            {
+                name: "--id=<id>",
+                description: "Sets the id of the integration to enable."
+            },
+            {
+                name: "--id=<name>",
+                description: "Sets the name of the integration to enable."
+            },
+            {
+                name: "--regex=<regex>",
+                description: "Enables integrations by matching name against the regular expression.",
+            },
+            {
+                name: "--dry-run",
+                description: "Prints the names of integrations that would be affected, but doesn't actually make any changes.",
+            },
+        ],
     },
 };