WIP: Add shell-completion commands

pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
     "cryptography >=42.0.5",
     "pyyaml >=6.0",
     "pyahocorasick >= 2.0.0",
+    "quick-click-auto >= 1.0.5"
 ]
 requires-python = ">= 3.8"
 

src/mvt/android/cli.py

@@ -6,6 +6,8 @@
 import logging
 
 import click
+from quick_click_auto import enable_click_shell_completion
+from quick_click_auto.constants import ShellType
 
 from mvt.common.cmd_check_iocs import CmdCheckIOCS
 from mvt.common.help import (
@@ -31,6 +33,7 @@
     HELP_MSG_HASHES,
     HELP_MSG_CHECK_IOCS,
     HELP_MSG_STIX2,
+    HELP_MSG_COMMAND_COMPLETION_ANDROID,
 )
 from mvt.common.logo import logo
 from mvt.common.updates import IndicatorsUpdates
@@ -69,6 +72,20 @@ def version():
     return
 
 
+# ==============================================================================
+# Command: shell-completion
+# ==============================================================================
+
+
+@cli.command("shell-completion", help=HELP_MSG_COMMAND_COMPLETION_ANDROID)
+def shell_completion():
+    enable_click_shell_completion(
+        program_name="mvt-android",
+        shells={ShellType.BASH, ShellType.ZSH},
+        verbose=True,
+    )
+
+
 # ==============================================================================
 # Command: download-apks
 # ==============================================================================

src/mvt/common/help.py

@@ -31,6 +31,8 @@
 HELP_MSG_EXTRACT_KEY = "Extract decryption key from an iTunes backup"
 HELP_MSG_CHECK_IOS_BACKUP = "Extract artifacts from an iTunes backup"
 HELP_MSG_CHECK_FS = "Extract artifacts from a full filesystem dump"
+HELP_MSG_COMMAND_COMPLETION_IOS = "Activate tab autocompletion for mvt-ios."
+
 
 # Android Specific
 HELP_MSG_SERIAL = "Specify a device serial number or HOST:PORT connection string"
@@ -49,3 +51,4 @@
 HELP_MSG_CHECK_BUGREPORT = "Check an Android Bug Report"
 HELP_MSG_CHECK_ANDROID_BACKUP = "Check an Android Backup"
 HELP_MSG_CHECK_ANDROIDQF = "Check data collected with AndroidQF"
+HELP_MSG_COMMAND_COMPLETION_ANDROID = "Activate tab autocompletion for mvt-android."

src/mvt/ios/cli.py

@@ -8,6 +8,9 @@
 import os
 
 import click
+from quick_click_auto import enable_click_shell_completion
+from quick_click_auto.constants import ShellType
+
 from rich.prompt import Prompt
 
 from mvt.common.cmd_check_iocs import CmdCheckIOCS
@@ -37,6 +40,7 @@
     HELP_MSG_CHECK_IOCS,
     HELP_MSG_STIX2,
     HELP_MSG_CHECK_IOS_BACKUP,
+    HELP_MSG_COMMAND_COMPLETION_IOS,
 )
 from .cmd_check_backup import CmdIOSCheckBackup
 from .cmd_check_fs import CmdIOSCheckFS
@@ -69,9 +73,25 @@ def version():
     return
 
 
+# ==============================================================================
+# Command: shell-completion
+# ==============================================================================
+
+
+@cli.command("shell-completion", help=HELP_MSG_COMMAND_COMPLETION_IOS)
+def shell_completion():
+    enable_click_shell_completion(
+        program_name="mvt-ios",
+        shells={ShellType.BASH},
+        verbose=True,
+    )
+
+
 # ==============================================================================
 # Command: decrypt-backup
 # ==============================================================================
+
+
 @cli.command(
     "decrypt-backup", context_settings=CONTEXT_SETTINGS, help=HELP_MSG_DECRYPT_BACKUP
 )