move authentication options to the root level

Author: MarshalX

cycode/cli/app.py

@@ -63,6 +63,7 @@ def export_if_needed_on_close(ctx: typer.Context) -> None:
         printer.export()
 
 
+_AUTH_RICH_HELP_PANEL = 'Authentication options'
 _COMPLETION_RICH_HELP_PANEL = 'Completion options'
 
 
@@ -83,6 +84,20 @@ def app_callback(
         Optional[str],
         typer.Option(hidden=True, help='Characteristic JSON object that lets servers identify the application.'),
     ] = None,
+    client_secret: Annotated[
+        Optional[str],
+        typer.Option(
+            help='Specify a Cycode client secret for this specific scan execution.',
+            rich_help_panel=_AUTH_RICH_HELP_PANEL,
+        ),
+    ] = None,
+    client_id: Annotated[
+        Optional[str],
+        typer.Option(
+            help='Specify a Cycode client ID for this specific scan execution.',
+            rich_help_panel=_AUTH_RICH_HELP_PANEL,
+        ),
+    ] = None,
     _: Annotated[
         Optional[bool],
         typer.Option(
@@ -122,6 +137,9 @@ def app_callback(
     if output == OutputTypeOption.JSON:
         no_progress_meter = True
 
+    ctx.obj['client_id'] = client_id
+    ctx.obj['client_secret'] = client_secret
+
     ctx.obj['progress_bar'] = get_progress_bar(hidden=no_progress_meter, sections=SCAN_PROGRESS_BAR_SECTIONS)
 
     ctx.obj['console_printer'] = ConsolePrinter(ctx)

cycode/cli/apps/ai_remediation/ai_remediation_command.py

@@ -24,7 +24,7 @@ def ai_remediation_command(
     * `cycode ai-remediation <detection_id>`: View remediation guidance
     * `cycode ai-remediation <detection_id> --fix`: Apply suggested fixes
     """
-    client = get_scan_cycode_client()
+    client = get_scan_cycode_client(ctx)
 
     try:
         remediation_markdown = client.get_ai_remediation(detection_id)

cycode/cli/apps/report/sbom/path/path_command.py

@@ -24,7 +24,7 @@ def path_command(
 ) -> None:
     add_breadcrumb('path')
 
-    client = get_report_cycode_client()
+    client = get_report_cycode_client(ctx)
     report_parameters = ctx.obj['report_parameters']
     output_format = report_parameters.output_format
     output_file = ctx.obj['output_file']

cycode/cli/apps/report/sbom/repository_url/repository_url_command.py

@@ -20,7 +20,7 @@ def repository_url_command(
     progress_bar.start()
     progress_bar.set_section_length(SbomReportProgressBarSection.PREPARE_LOCAL_FILES)
 
-    client = get_report_cycode_client()
+    client = get_report_cycode_client(ctx)
     report_parameters = ctx.obj['report_parameters']
     output_file = ctx.obj['output_file']
     output_format = report_parameters.output_format

cycode/cli/apps/scan/scan_command.py

@@ -13,7 +13,6 @@
 from cycode.cli.utils.get_api_client import get_scan_cycode_client
 from cycode.cli.utils.sentry import add_breadcrumb
 
-_AUTH_RICH_HELP_PANEL = 'Authentication options'
 _EXPORT_RICH_HELP_PANEL = 'Export options'
 _SCA_RICH_HELP_PANEL = 'SCA options'
 _SECRET_RICH_HELP_PANEL = 'Secret options'
@@ -30,20 +29,6 @@ def scan_command(
             case_sensitive=False,
         ),
     ] = ScanTypeOption.SECRET,
-    client_secret: Annotated[
-        Optional[str],
-        typer.Option(
-            help='Specify a Cycode client secret for this specific scan execution.',
-            rich_help_panel=_AUTH_RICH_HELP_PANEL,
-        ),
-    ] = None,
-    client_id: Annotated[
-        Optional[str],
-        typer.Option(
-            help='Specify a Cycode client ID for this specific scan execution.',
-            rich_help_panel=_AUTH_RICH_HELP_PANEL,
-        ),
-    ] = None,
     show_secret: Annotated[
         bool, typer.Option('--show-secret', help='Show Secrets in plain text.', rich_help_panel=_SECRET_RICH_HELP_PANEL)
     ] = False,
@@ -143,7 +128,7 @@ def scan_command(
 
     ctx.obj['show_secret'] = show_secret
     ctx.obj['soft_fail'] = soft_fail
-    ctx.obj['client'] = get_scan_cycode_client(client_id, client_secret, not ctx.obj['show_secret'])
+    ctx.obj['client'] = get_scan_cycode_client(ctx)
     ctx.obj['scan_type'] = scan_type
     ctx.obj['sync'] = sync
     ctx.obj['severity_threshold'] = severity_threshold

cycode/cli/apps/status/get_cli_status.py

@@ -22,7 +22,7 @@ def get_cli_status(ctx: 'Context') -> CliStatus:
     supported_modules_status = CliSupportedModulesStatus()
     if is_authenticated:
         try:
-            client = get_scan_cycode_client()
+            client = get_scan_cycode_client(ctx)
             supported_modules_preferences = client.get_supported_modules_preferences()
 
             supported_modules_status.secret_scanning = supported_modules_preferences.secret_scanning

cycode/cli/utils/get_api_client.py

@@ -6,6 +6,8 @@
 from cycode.cyclient.client_creator import create_report_client, create_scan_client
 
 if TYPE_CHECKING:
+    import typer
+
     from cycode.cyclient.report_client import ReportClient
     from cycode.cyclient.scan_client import ScanClient
 
@@ -23,15 +25,16 @@ def _get_cycode_client(
     return create_client_func(client_id, client_secret, hide_response_log)
 
 
-def get_scan_cycode_client(
-    client_id: Optional[str] = None, client_secret: Optional[str] = None, hide_response_log: bool = True
-) -> 'ScanClient':
+def get_scan_cycode_client(ctx: 'typer.Context') -> 'ScanClient':
+    client_id = ctx.obj.get('client_id')
+    client_secret = ctx.obj.get('client_secret')
+    hide_response_log = not ctx.obj['show_secret']
     return _get_cycode_client(create_scan_client, client_id, client_secret, hide_response_log)
 
 
-def get_report_cycode_client(
-    client_id: Optional[str] = None, client_secret: Optional[str] = None, hide_response_log: bool = True
-) -> 'ReportClient':
+def get_report_cycode_client(ctx: 'typer.Context', hide_response_log: bool = True) -> 'ReportClient':
+    client_id = ctx.obj.get('client_id')
+    client_secret = ctx.obj.get('client_secret')
     return _get_cycode_client(create_report_client, client_id, client_secret, hide_response_log)