Colorize CLI commands usage

pyproject.toml

@@ -23,6 +23,7 @@ requests-toolbelt = "1.0.0"
 requests = "2.31.0"
 rich = "13.7.1"
 xlsxwriter = "3.2.0"
+click-help-colors = "^0.9.4"
 
 [tool.poetry.group.dev.dependencies]
 coverage = { extras = ["toml"], version = "^7.4.4" }

spacemk/cli.py

@@ -5,6 +5,7 @@
 import ccl
 import click
 from benedict import benedict
+from click_help_colors import HelpColorsGroup
 from dotenv import load_dotenv
 from envyaml import EnvYAML
 from icecream import ic
@@ -14,7 +15,12 @@
 debug_enabled = False
 
 
-@click.group(help="Helper to move from various tools to Spacelift.")
+@click.group(
+    cls=HelpColorsGroup,
+    help="Helper to move from various tools to Spacelift.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @click.option(
     "--config",
     default="config.yml",

spacemk/commands/audit.py

@@ -1,10 +1,16 @@
 import click
 from click.decorators import pass_meta_key
+from click_help_colors import HelpColorsCommand
 
 from spacemk.exporters import load_exporter
 
 
-@click.command(help="Audit the source vendor setup.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Audit the source vendor setup.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @pass_meta_key("config")
 def audit(config):
     exporter = load_exporter(config=config.get("exporter", {}))

spacemk/commands/create_module_versions.py

@@ -2,6 +2,7 @@
 
 import click
 import requests
+from click_help_colors import HelpColorsCommand
 from requests_toolbelt.utils import dump as request_dump
 
 from spacemk import load_normalized_data
@@ -31,7 +32,12 @@ def _get_repository_tags(endpoint: str, github_api_token: str, namespace: str, r
     return data
 
 
-@click.command(help="Create module versions.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Create module versions.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @click.decorators.pass_meta_key("config")
 def create_module_versions(config):
     data = load_normalized_data()

spacemk/commands/export.py

@@ -1,10 +1,16 @@
 import click
 from click.decorators import pass_meta_key
+from click_help_colors import HelpColorsCommand
 
 from spacemk.exporters import load_exporter
 
 
-@click.command(help="Export information from the source vendor.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Export information from the source vendor.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @pass_meta_key("config")
 def export(config):
     exporter = load_exporter(config=config.get("exporter", {}))

spacemk/commands/generate.py

@@ -1,9 +1,15 @@
 import click
+from click_help_colors import HelpColorsCommand
 
 from spacemk.generator import Generator
 
 
-@click.command(help="Generate Terraform code to manage Spacelift entities.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Generate Terraform code to manage Spacelift entities.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 def generate():
     generator = Generator()
     generator.generate()

spacemk/commands/set_sensitive_env_vars.py

@@ -1,10 +1,16 @@
 import click
 from click.decorators import pass_meta_key
+from click_help_colors import HelpColorsCommand
 
 from spacemk.spacelift import Spacelift
 
 
-@click.command(help="Set sensitive environment variable values in Spacelift.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Set sensitive environment variable values in Spacelift.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @pass_meta_key("config")
 def set_sensitive_env_vars(config):
     spacelift = Spacelift(config.get("spacelift"))

spacemk/commands/set_tf_vars_with_invalid_name.py

@@ -1,10 +1,16 @@
 import click
 from click.decorators import pass_meta_key
+from click_help_colors import HelpColorsCommand
 
 from spacemk.spacelift import Spacelift
 
 
-@click.command(help="Set value of Terraform variable with invalid name in Spacelift.")
+@click.command(
+    cls=HelpColorsCommand,
+    help="Set value of Terraform variable with invalid name in Spacelift.",
+    help_headers_color="yellow",
+    help_options_color="green",
+)
 @pass_meta_key("config")
 def set_tf_vars_with_invalid_name(config):
     spacelift = Spacelift(config.get("spacelift"))