Bump version to 1.2.4 and add version command to BloodHound CLI

This commit updates the version to 1.2.4 in the project metadata and introduces a new command to display the CLI version. The README has been updated to include usage instructions for the version command, ensuring users can easily check the current version of the tool.

Author: ADScanPro

README.md

@@ -77,6 +77,13 @@ bloodhound-cli --edition legacy user -d mydomain.local
 bloodhound-cli --edition ce user -d mydomain.local
 ```
 
+#### Show Version
+```bash
+bloodhound-cli version
+# or
+bloodhound-cli --version
+```
+
 #### List Group Memberships For A User
 ```bash
 # Resolve recursive memberships (default)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bloodhound-cli"  # The package name as installed via pip (pip install bloodhound-cli)
-version = "1.2.3"          # Bump: add CE skeleton, --edition, --verbose, rich optional
+version = "1.2.4"          # Bump: add CE skeleton, --edition, --verbose, rich optional
 description = "CLI for querying BloodHound data (Legacy Neo4j + CE skeleton)."
 readme = "README.md"
 authors = [

src/bloodhound_cli/__init__.py

@@ -1,6 +1,6 @@
 """BloodHound CLI package entrypoint."""
 
-__version__ = "1.2.3"
+__version__ = "1.2.4"
 __all__ = ["__version__"]
 
 # End of package metadata

src/bloodhound_cli/core/logging_utils.py

@@ -8,7 +8,7 @@
 
 import structlog
 
-_LOGGER_INITIALISED = False
+_logger_initialized = False
 
 
 def configure_logging(debug: bool = False, json_output: bool = False) -> None:
@@ -18,8 +18,8 @@ def configure_logging(debug: bool = False, json_output: bool = False) -> None:
         debug: Whether to emit debug-level events.
         json_output: Emit logs as JSON instead of human-readable console output.
     """
-    global _LOGGER_INITIALISED  # pylint: disable=global-statement
-    if _LOGGER_INITIALISED:
+    global _logger_initialized  # pylint: disable=global-statement
+    if _logger_initialized:
         return
 
     level = logging.DEBUG if debug else logging.INFO
@@ -43,7 +43,7 @@ def configure_logging(debug: bool = False, json_output: bool = False) -> None:
         wrapper_class=structlog.make_filtering_bound_logger(level),
         cache_logger_on_first_use=True,
     )
-    _LOGGER_INITIALISED = True
+    _logger_initialized = True
 
 
 def get_logger(name: str | None = None, **initial_context: Any) -> structlog.BoundLogger:

src/bloodhound_cli/main.py

@@ -16,6 +16,7 @@
     sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
     __package__ = "bloodhound_cli"
 
+from . import __version__ as PACKAGE_VERSION
 from .core.factory import create_bloodhound_client
 from .core.logging_utils import configure_logging, get_logger
 from .core.settings import load_ce_config, load_legacy_config, CONFIG_FILE, CEConfig
@@ -24,6 +25,14 @@
 LOGGER = get_logger("cli")
 
 
+def get_cli_version() -> str:
+    """Return the CLI version string."""
+    return PACKAGE_VERSION or "unknown"
+
+
+CLI_VERSION = get_cli_version()
+
+
 def load_config():
     """Load configuration from ~/.bloodhound_config"""
     config_path = os.path.expanduser("~/.bloodhound_config")
@@ -222,6 +231,11 @@ def cmd_group(args):
         client.close()
 
 
+def cmd_version(args):  # pylint: disable=unused-argument
+    """Display the CLI version."""
+    print(f"bloodhound-cli {CLI_VERSION}")
+
+
 def register_group_subcommand(subparsers):
     """Register the 'group' command parser."""
     group_parser = subparsers.add_parser(
@@ -245,6 +259,12 @@ def register_group_subcommand(subparsers):
     group_parser.set_defaults(func=cmd_group)
 
 
+def register_version_subcommand(subparsers):
+    """Register the 'version' command parser."""
+    version_parser = subparsers.add_parser("version", help="Show CLI version")
+    version_parser.set_defaults(func=cmd_version)
+
+
 def cmd_computers(args):
     """List computers in a domain"""
     logger = LOGGER.bind(command="computer", edition=args.edition, domain=args.domain)
@@ -653,6 +673,12 @@ def main():
         "--verbose", "-v", action="store_true", help="Enable verbose output"
     )
     parser.add_argument("-o", "--output", help="Output file to save results")
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {CLI_VERSION}",
+        help="Show CLI version and exit",
+    )
 
     # Legacy connection options
     parser.add_argument(
@@ -813,6 +839,9 @@ def main():
     )
     auth_parser.set_defaults(func=cmd_auth)
 
+    # Version command
+    register_version_subcommand(subparsers)
+
     args = parser.parse_args()
 
     configure_logging(debug=args.debug)

tests/unit/test_ce_queries.py

@@ -736,6 +736,12 @@ def close(self):
         assert dummy_client.calls == [("essos.local", "daenerys.targaryen", True)]
         assert dummy_client.closed is True
 
+    def test_version_command_prints_version(self, capsys):
+        """Ensure `bloodhound-cli version` prints the version string."""
+        cli_main.cmd_version(SimpleNamespace())
+        captured = capsys.readouterr()
+        assert captured.out.strip() == f"bloodhound-cli {cli_main.get_cli_version()}"
+
     @pytest.fixture
     def mock_ce_client_graph(self):
         client = BloodHoundCEClient(