- Update bashly doc with command.help_header_override

DannyBen · Feb 15, 2025 · 4e50fe1 · 4e50fe1
1 parent 188dbca
commit 4e50fe1
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/lib/bashly/docs/command.yml b/lib/bashly/docs/command.yml
@@ -289,6 +289,20 @@ command.help:
     - name: images
       help: Manage images
 
+command.help_header_override:
+  help: Provide an alternative bash code (or function call) that will be executed at the beginning of the help message.
+
+  url: https://bashly.dev/configuration/command/#help_header_override
+  example: |-
+    name: font-explorer
+    help: Font manager utility
+
+    help_header_override: |
+      echo '┏┓       ┏┓    ┓        '
+      echo '┣ ┏┓┏┓╋  ┣ ┓┏┏┓┃┏┓┏┓┏┓┏┓'
+      echo '┻ ┗┛┛┗┗  ┗┛┛┗┣┛┗┗┛┛ ┗ ┛ '
+      echo '             ┛      v1.0'
+
 command.name:
   help: Specify the name of the command. This option is required.
   url: https://bashly.dev/configuration/command/#name

diff --git a/spec/approvals/cli/doc/full b/spec/approvals/cli/doc/full
@@ -443,6 +443,22 @@ command.help
 
   See https://bashly.dev/configuration/command/#help
 
+command.help_header_override
+
+  Provide an alternative bash code (or function call) that will be executed at
+  the beginning of the help message.
+
+    name: font-explorer
+    help: Font manager utility
+
+    help_header_override: |
+      echo '┏┓       ┏┓    ┓        '
+      echo '┣ ┏┓┏┓╋  ┣ ┓┏┏┓┃┏┓┏┓┏┓┏┓'
+      echo '┻ ┗┛┛┗┗  ┗┛┛┗┣┛┗┗┛┛ ┗ ┛ '
+      echo '             ┛      v1.0'
+
+  See https://bashly.dev/configuration/command/#help_header_override
+
 command.name
 
   Specify the name of the command. This option is required.

diff --git a/spec/approvals/cli/doc/index b/spec/approvals/cli/doc/index
@@ -25,6 +25,7 @@ command.footer
 command.function
 command.group
 command.help
+command.help_header_override
 command.name
 command.private
 command.variables