add help for commands; add epilog; remove "auth check" command; fix ignore command

Author: MarshalX

cycode/cli/apps/ai_remediation/__init__.py

@@ -2,8 +2,19 @@
 
 from cycode.cli.apps.ai_remediation.ai_remediation_command import ai_remediation_command
 
-app = typer.Typer(no_args_is_help=True)
-app.command(name='ai-remediation', short_help='Get AI remediation (INTERNAL).', hidden=True)(ai_remediation_command)
+app = typer.Typer()
+
+_ai_remediation_epilog = """
+Note: AI remediation suggestions are generated automatically and should be reviewed before applying.
+"""
+
+app.command(
+    name='ai-remediation',
+    short_help='Get AI remediation (INTERNAL).',
+    epilog=_ai_remediation_epilog,
+    hidden=True,
+    no_args_is_help=True,
+)(ai_remediation_command)
 
 # backward compatibility
 app.command(hidden=True, name='ai_remediation')(ai_remediation_command)

cycode/cli/apps/ai_remediation/ai_remediation_command.py

@@ -16,7 +16,14 @@ def ai_remediation_command(
         bool, typer.Option('--fix', help='Apply fixes to resolve violations. Note: fix could be not available.')
     ] = False,
 ) -> None:
-    """Get AI remediation (INTERNAL)."""
+    """:robot: [bold cyan]Get AI-powered remediation for security issues.[/]
+
+    This command provides AI-generated remediation guidance for detected security issues.
+
+    Example usage:
+    * `cycode ai-remediation <detection_id>`: View remediation guidance
+    * `cycode ai-remediation <detection_id> --fix`: Apply suggested fixes
+    """
     client = get_scan_cycode_client()
 
     try:

cycode/cli/apps/auth/__init__.py

@@ -1,12 +1,14 @@
 import typer
 
 from cycode.cli.apps.auth.auth_command import auth_command
-from cycode.cli.apps.auth.check_command import check_command
-
-app = typer.Typer(
-    name='auth',
-    help='Authenticate your machine to associate the CLI with your Cycode account.',
-    no_args_is_help=True,
-)
-app.callback(invoke_without_command=True)(auth_command)
-app.command(name='check')(check_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]
+"""
+
+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/auth_command.py

@@ -8,14 +8,18 @@
 
 
 def auth_command(ctx: typer.Context) -> None:
-    """Authenticates your machine."""
+    """:key: [bold cyan]Authenticate your machine with Cycode.[/]
+
+    This command handles authentication with Cycode's security platform.
+
+    Example usage:
+    * `cycode auth`: Start interactive authentication
+    * `cycode auth --help`: View authentication options
+    """
+
     add_breadcrumb('auth')
     printer = ctx.obj.get('console_printer')
 
-    if ctx.invoked_subcommand is not None:
-        # if it is a subcommand, do nothing
-        return
-
     try:
         logger.debug('Starting authentication process')
 

cycode/cli/apps/auth/auth_common.py

@@ -1,15 +1,16 @@
-from typing import Optional
-
-import typer
+from typing import TYPE_CHECKING, Optional
 
 from cycode.cli.apps.auth.models import AuthInfo
 from cycode.cli.exceptions.custom_exceptions import HttpUnauthorizedError, RequestHttpError
 from cycode.cli.user_settings.credentials_manager import CredentialsManager
 from cycode.cli.utils.jwt_utils import get_user_and_tenant_ids_from_access_token
 from cycode.cyclient.cycode_token_based_client import CycodeTokenBasedClient
 
+if TYPE_CHECKING:
+    from typer import Context
+
 
-def get_authorization_info(ctx: Optional[typer.Context] = None) -> Optional[AuthInfo]:
+def get_authorization_info(ctx: 'Context') -> Optional[AuthInfo]:
     printer = ctx.obj.get('console_printer')
 
     client_id, client_secret = CredentialsManager().get_credentials()

cycode/cli/apps/auth/check_command.py

@@ -2,7 +2,18 @@
 
 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]
+"""
+
+
 app = typer.Typer(no_args_is_help=True)
-app.command(name='configure', short_help='Initial command to configure your CLI client authentication.')(
-    configure_command
-)
+app.command(
+    name='configure',
+    epilog=_configure_command_epilog,
+    short_help='Initial command to configure your CLI client authentication.',
+)(configure_command)

cycode/cli/apps/configure/__init__.py

@@ -23,7 +23,20 @@ def _should_update_value(
 
 
 def configure_command() -> None:
-    """Configure your CLI client authentication manually."""
+    """:gear: [bold cyan]Configure Cycode CLI settings.[/]
+
+    This command allows you to configure various aspects of the Cycode CLI.
+
+    Configuration options:
+    * API URL: The base URL for Cycode's API (for on-premise or EU installations)
+    * APP URL: The base URL for Cycode's web application (for on-premise or EU installations)
+    * Client ID: Your Cycode client ID for authentication
+    * Client Secret: Your Cycode client secret for authentication
+
+    Example usage:
+    * `cycode configure`: Start interactive configuration
+    * `cycode configure --help`: View configuration options
+    """
     add_breadcrumb('configure')
 
     global_config_manager = CONFIGURATION_MANAGER.global_config_file_manager

cycode/cli/apps/configure/configure_command.py

@@ -83,7 +83,20 @@ def ignore_command(  # noqa: C901
         bool, typer.Option('--global', '-g', help='Add an ignore rule to the global CLI config.')
     ] = False,
 ) -> None:
-    """Ignores a specific value, path or rule ID."""
+    """:no_entry: [bold cyan]Ignore specific findings or paths in scans.[/]
+
+    This command allows you to exclude specific items from Cycode scans, including:
+    * Paths: Exclude specific files or directories
+    * Rules: Ignore specific security rules
+    * Values: Exclude specific sensitive values
+    * Packages: Ignore specific package versions
+    * CVEs: Exclude specific vulnerabilities
+
+    Example usage:
+    * `cycode ignore --by-path .env`: Ignore the tests directory
+    * `cycode ignore --by-rule GUID`: Ignore rule with the specified GUID
+    * `cycode ignore --by-package [email protected]`: Ignore lodash version 4.17.21
+    """
     add_breadcrumb('ignore')
 
     all_by_values = [by_value, by_sha, by_path, by_rule, by_package, by_cve]
@@ -145,4 +158,4 @@ def ignore_command(  # noqa: C901
             'exclusion_value': exclusion_value,
         },
     )
-    configuration_manager.add_exclusion(configuration_scope, scan_type, exclusion_type, exclusion_value)
+    configuration_manager.add_exclusion(configuration_scope, str(scan_type), exclusion_type, exclusion_value)

cycode/cli/apps/ignore/ignore_command.py

@@ -5,7 +5,11 @@
 
 
 def report_command(ctx: typer.Context) -> int:
-    """Generate report."""
+    """:bar_chart: [bold cyan]Generate security reports.[/]
+
+    Example usage:
+    * `cycode report sbom`: Generate SBOM report
+    """
     add_breadcrumb('report')
     ctx.obj['progress_bar'] = get_progress_bar(hidden=False, sections=SBOM_REPORT_PROGRESS_BAR_SECTIONS)
     return 1