INNER CODE UNIT · Python
format_help
mikel-brostrom/boxmot · boxmot/engine/cli.py:105
def format_help(self, _ctx: click.Context, formatter: click.HelpFormatter) -> None:
"""Render the command-first BoxMOT help without resolving child commands."""
formatter.write_paragraph()
formatter.write_text("BoxMOT 'boxmot' commands use the following syntax:")
formatter.write_paragraph()
with formatter.indentation():
formatter.write_text("boxmot MODE [OPTIONS]")
formatter.write_paragraph()
formatter.width = 120
with formatter.indentation():
modes = ", ".join(spec.name for spec in _COMMAND_SPECS)
formatter.write_text(f"Where MODE (required) is one of [{modes}]")
formatter.write_text(" --detector selects a YOLO model like yolov8n, yolov9c, yolo11m, yolox_x")
formatter.write_text(" --reid selects a ReID model like osnet_x0_25_msmt17, mobilenetv2_x1_4")
formatter.write_text(f" --tracker selects one of [{_TRACKER_HELP}]")