Make changes in CLI v3.0.0 after feedback (part 2) (#303)

Author: MarshalX

README.md

@@ -21,10 +21,9 @@ This guide walks you through both installation and usage.
         1. [Options](#options)
            1. [Severity Threshold](#severity-option)
            2. [Monitor](#monitor-option)
-           3. [Report](#report-option)
-           4. [Package Vulnerabilities](#package-vulnerabilities-option)
-           5. [License Compliance](#license-compliance-option)
-           6. [Lock Restore](#lock-restore-option)
+           3. [Package Vulnerabilities](#package-vulnerabilities-option)
+           4. [License Compliance](#license-compliance-option)
+           5. [Lock Restore](#lock-restore-option)
         2. [Repository Scan](#repository-scan)
             1. [Branch Option](#branch-option)
         3. [Path Scan](#path-scan)
@@ -282,7 +281,7 @@ The following are the options and commands available with the Cycode CLI applica
 | [configure](#using-the-configure-command) | Initial command to configure your CLI client authentication.                                                                                 |
 | [ignore](#ignoring-scan-results)          | Ignores a specific value, path or rule ID.                                                                                                   |
 | [scan](#running-a-scan)                   | Scan the content for Secrets/IaC/SCA/SAST violations. You`ll need to specify which scan type to perform: commit-history/path/repository/etc. |
-| [report](#report-command)                 | Generate report. You`ll need to specify which report type to perform.                                                                        |
+| [report](#report-command)                 | Generate report. You`ll need to specify which report type to perform as SBOM.                                                                |
 | status                                    | Show the CLI status and exit.                                                                                                                |
 
 # Scan Command
@@ -301,7 +300,6 @@ The Cycode CLI application offers several types of scans so that you can choose
 | `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher.                                                                                                                                                                                                  |
 | `--sca-scan`                                               | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both.                                                                                                                                         |
 | `--monitor`                                                | When specified, the scan results will be recorded in the knowledge graph. Please note that when working in `monitor` mode, the knowledge graph will not be updated as a result of SCM events (Push, Repo creation). (Supported for SCA scan type only). |
-| `--report`                                                 | When specified, a violations report will be generated. A URL link to the report will be printed as an output to the command execution.                                                                                                                  |
 | `--no-restore`                                             | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY!                                                                                                                                                                |
 | `--gradle-all-sub-projects`                                | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY!                                                                                                                               |
 | `--help`                                                   | Show options for given command.                                                                                                                                                                                                                         |
@@ -339,28 +337,6 @@ When using this option, the scan results from this scan will appear in the knowl
 > [!WARNING]
 > You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.
 
-#### Report Option
-
-> [!NOTE]
-> This option is not available to IaC scans.
-
-To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in the Repository scan to Cycode, add the argument `--report` to the scan command.
-
-`cycode scan -t sca --report repository ~/home/git/codebase`
-
-In the same way, you can push scan results of Secrets and SAST scans to Cycode by adding the `--report` option to the scan command.
-
-When using this option, the scan results from this scan will appear in the On-Demand Scans section of Cycode. To get to this page, click the link that appears after the printed results:
-
-> [!WARNING]
-> You must be an `owner` or an `admin` in Cycode to view this page.
-
-![cli-report](https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/sca_report_url.png)
-
-The report page will look something like below:
-
-![](https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/scan_details.png)
-
 #### Package Vulnerabilities Option
 
 > [!NOTE]

cycode/__main__.py

@@ -0,0 +1,4 @@
+from cycode.cli.consts import PROGRAM_NAME
+from cycode.cli.main import app
+
+app(prog_name=PROGRAM_NAME)

cycode/cli/__main__.py

@@ -1,14 +1,14 @@
 import logging
-from pathlib import Path
 from typing import Annotated, Optional
 
 import typer
 from typer import rich_utils
+from typer._completion_classes import completion_init
 from typer.completion import install_callback, show_callback
 
 from cycode import __version__
 from cycode.cli.apps import ai_remediation, auth, configure, ignore, report, scan, status
-from cycode.cli.cli_types import ExportTypeOption, OutputTypeOption
+from cycode.cli.cli_types import OutputTypeOption
 from cycode.cli.consts import CLI_CONTEXT_SETTINGS
 from cycode.cli.printers import ConsolePrinter
 from cycode.cli.user_settings.configuration_manager import ConfigurationManager
@@ -24,14 +24,10 @@
 # By default, it uses blue color which is too dark for some terminals
 rich_utils.RICH_HELP = "Try [cyan]'{command_path} {help_option}'[/] for help."
 
+completion_init()  # DO NOT TOUCH; this is required for the completion to work properly
 
 _cycode_cli_docs = 'https://github.com/cycodehq/cycode-cli/blob/main/README.md'
-_cycode_cli_epilog = f"""[bold]Documentation[/]
-
-
-
-For more details and advanced usage, visit: [link={_cycode_cli_docs}]{_cycode_cli_docs}[/link]
-"""
+_cycode_cli_epilog = f'[bold]Documentation:[/] [link={_cycode_cli_docs}]{_cycode_cli_docs}[/link]'
 
 app = typer.Typer(
     pretty_exceptions_show_locals=False,
@@ -64,13 +60,14 @@ def check_latest_version_on_close(ctx: typer.Context) -> None:
 
 
 def export_if_needed_on_close(ctx: typer.Context) -> None:
+    scan_finalized = ctx.obj.get('scan_finalized')
     printer = ctx.obj.get('console_printer')
-    if printer.is_recording:
+    if scan_finalized and printer.is_recording:
         printer.export()
 
 
+_AUTH_RICH_HELP_PANEL = 'Authentication options'
 _COMPLETION_RICH_HELP_PANEL = 'Completion options'
-_EXPORT_RICH_HELP_PANEL = 'Export options'
 
 
 @app.callback()
@@ -90,25 +87,18 @@ def app_callback(
         Optional[str],
         typer.Option(hidden=True, help='Characteristic JSON object that lets servers identify the application.'),
     ] = None,
-    export_type: Annotated[
-        ExportTypeOption,
+    client_secret: Annotated[
+        Optional[str],
         typer.Option(
-            '--export-type',
-            case_sensitive=False,
-            help='Specify the export type. '
-            'HTML and SVG will export terminal output and rely on --output option. '
-            'JSON always exports JSON.',
-            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
+            help='Specify a Cycode client secret for this specific scan execution.',
+            rich_help_panel=_AUTH_RICH_HELP_PANEL,
         ),
-    ] = ExportTypeOption.JSON,
-    export_file: Annotated[
-        Optional[Path],
+    ] = None,
+    client_id: Annotated[
+        Optional[str],
         typer.Option(
-            '--export-file',
-            help='Export file. Path to the file where the export will be saved. ',
-            dir_okay=False,
-            writable=True,
-            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
+            help='Specify a Cycode client ID for this specific scan execution.',
+            rich_help_panel=_AUTH_RICH_HELP_PANEL,
         ),
     ] = None,
     _: Annotated[
@@ -150,10 +140,11 @@ 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['export_type'] = export_type
-    ctx.obj['export_file'] = export_file
     ctx.obj['console_printer'] = ConsolePrinter(ctx)
     ctx.call_on_close(lambda: export_if_needed_on_close(ctx))
 

cycode/cli/app.py

@@ -4,9 +4,9 @@
 
 app = typer.Typer()
 
-_ai_remediation_epilog = """
-Note: AI remediation suggestions are generated automatically and should be reviewed before applying.
-"""
+_ai_remediation_epilog = (
+    'Note: AI remediation suggestions are generated automatically and should be reviewed before applying.'
+)
 
 app.command(
     name='ai-remediation',

cycode/cli/apps/ai_remediation/__init__.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/ai_remediation/ai_remediation_command.py

@@ -3,12 +3,7 @@
 from cycode.cli.apps.auth.auth_command import auth_command
 
 _auth_command_docs = 'https://github.com/cycodehq/cycode-cli/blob/main/README.md#using-the-auth-command'
-_auth_command_epilog = f"""[bold]Documentation[/]
-
-
-
-For more details and advanced usage, visit: [link={_auth_command_docs}]{_auth_command_docs}[/link]
-"""
+_auth_command_epilog = f'[bold]Documentation:[/] [link={_auth_command_docs}]{_auth_command_docs}[/link]'
 
 app = typer.Typer(no_args_is_help=False)
 app.command(name='auth', epilog=_auth_command_epilog, short_help='Authenticate your machine with Cycode.')(auth_command)

cycode/cli/apps/auth/__init__.py

@@ -13,7 +13,10 @@
 def get_authorization_info(ctx: 'Context') -> Optional[AuthInfo]:
     printer = ctx.obj.get('console_printer')
 
-    client_id, client_secret = CredentialsManager().get_credentials()
+    client_id, client_secret = ctx.obj.get('client_id'), ctx.obj.get('client_secret')
+    if not client_id or not client_secret:
+        client_id, client_secret = CredentialsManager().get_credentials()
+
     if not client_id or not client_secret:
         return None
 

cycode/cli/apps/auth/auth_common.py

@@ -3,12 +3,7 @@
 from cycode.cli.apps.configure.configure_command import configure_command
 
 _configure_command_docs = 'https://github.com/cycodehq/cycode-cli/blob/main/README.md#using-the-configure-command'
-_configure_command_epilog = f"""[bold]Documentation[/]
-
-
-
-For more details and advanced usage, visit: [link={_configure_command_docs}]{_configure_command_docs}[/link]
-"""
+_configure_command_epilog = f'[bold]Documentation:[/] [link={_configure_command_docs}]{_configure_command_docs}[/link]'
 
 
 app = typer.Typer(no_args_is_help=True)

cycode/cli/apps/configure/__init__.py

@@ -4,5 +4,5 @@
 from cycode.cli.apps.report.report_command import report_command
 
 app = typer.Typer(name='report', no_args_is_help=True)
-app.callback(short_help='Generate report. You`ll need to specify which report type to perform.')(report_command)
+app.callback(short_help='Generate report. You`ll need to specify which report type to perform as SBOM.')(report_command)
 app.add_typer(sbom.app)