206 lines
8.5 KiB
Python
206 lines
8.5 KiB
Python
# Console Help Theme
|
|
CONSOLE_HELP_THEME = {"nhc": "grey82"}
|
|
|
|
CLI_AUTH_COMMAND_HELP = (
|
|
"Authenticate Safety CLI to perform scans. Your default browser will automatically open to "
|
|
"https://platform.safetycli.com.\n\n"
|
|
"Example:\n safety auth login\n\n"
|
|
"For headless authentication, you will receive a URL to paste into an external browser.\n\n"
|
|
"Example:\n safety auth login --headless"
|
|
)
|
|
|
|
CLI_AUTH_HEADLESS_HELP = "For headless authentication, you will receive a URL to paste into an external browser."
|
|
|
|
CLI_SCAN_COMMAND_HELP = (
|
|
"Scans a Python project directory."
|
|
"\nExample: safety scan to scan the current directory"
|
|
)
|
|
CLI_SYSTEM_SCAN_COMMAND_HELP = (
|
|
"\\[beta] Run a comprehensive scan for packages and vulnerabilities across your entire machine/environment."
|
|
"\nExample: safety system-scan"
|
|
)
|
|
|
|
CLI_CHECK_COMMAND_HELP = (
|
|
"\\[deprecated] Find vulnerabilities at target files or environments. Now replaced by safety scan, and will be unsupported beyond 1 May 2024."
|
|
"\nExample: safety check -r requirements.txt"
|
|
)
|
|
CLI_LICENSES_COMMAND_HELP = (
|
|
"\\[deprecated] Find licenses at target files or environments. This command will be replaced by safety scan, and will be unsupported beyond 1 May 2024."
|
|
"\nExample: safety license -r requirements.txt"
|
|
)
|
|
|
|
|
|
CLI_ALERT_COMMAND_HELP = (
|
|
"\\[deprecated] Create GitHub pull requests or GitHub issues using a `safety check` json report file. Being replaced by newer features."
|
|
"\nExample: safety alert --check-report your-report.json --key API_KEY github-pr --repo my-org/my-repo --token github-token"
|
|
)
|
|
|
|
CLI_CHECK_UPDATES_HELP = (
|
|
"Check for version updates to Safety CLI.\nExample: safety check-updates"
|
|
)
|
|
|
|
CLI_CONFIGURE_HELP = (
|
|
"Set up global configurations for Safety CLI, including proxy settings and organization details."
|
|
"\nExample: safety configure --proxy-host 192.168.0.1"
|
|
)
|
|
|
|
CLI_GENERATE_HELP = (
|
|
"Generate a boilerplate Safety CLI policy file for customized security policies."
|
|
"\nNote: Safety Platform policies will override any local policy files found"
|
|
"\nExample: safety generate policy_file"
|
|
)
|
|
|
|
CLI_VALIDATE_HELP = (
|
|
"Check if your local Safety CLI policy file is valid."
|
|
"\nExample: Example: safety validate --path /path/to/policy.yml"
|
|
)
|
|
|
|
CLI_GATEWAY_CONFIGURE_COMMAND_HELP = (
|
|
"Configures the project in the working directory to use Gateway."
|
|
)
|
|
|
|
# Global options help
|
|
_CLI_PROXY_TIP_HELP = "[nhc]Note: proxy details can be set globally in a config file.[/nhc]\n\nSee [bold]safety configure --help[/bold]\n\n"
|
|
|
|
CLI_PROXY_HOST_HELP = (
|
|
"Specify a proxy host for network communications. \n\n" + _CLI_PROXY_TIP_HELP
|
|
)
|
|
|
|
CLI_PROXY_PORT_HELP = "Set the proxy port (default: 80).\n\n" + _CLI_PROXY_TIP_HELP
|
|
|
|
CLI_PROXY_PROTOCOL_HELP = (
|
|
"Choose the proxy protocol (default: https).\n\n" + _CLI_PROXY_TIP_HELP
|
|
)
|
|
|
|
CLI_KEY_HELP = (
|
|
"The API key required for cicd stage or production stage scans.\n\n"
|
|
"[nhc]For development stage scans unset the API key and authenticate using [bold]safety auth[/bold].[/nhc]\n\n"
|
|
"[nhc]Tip: the API key can also be set using the environment variable: SAFETY_API_KEY[/nhc]\n\n"
|
|
"[bold]Example: safety --key API_KEY scan[/bold]"
|
|
)
|
|
|
|
CLI_STAGE_HELP = (
|
|
"Assign a development lifecycle stage to your scan (default: development).\n\n"
|
|
"[nhc]This labels the scan and its findings in Safety Platform with this stage.[/nhc]\n\n"
|
|
"[bold]Example: safety --stage production scan[/bold]"
|
|
)
|
|
|
|
CLI_DEBUG_HELP = (
|
|
"Enable debug mode for detailed output.\n\n"
|
|
"[bold]Example: safety --debug scan[/bold]"
|
|
)
|
|
|
|
CLI_DISABLE_OPTIONAL_TELEMETRY_DATA_HELP = (
|
|
"Opt-out of sending optional telemetry data. Anonymized telemetry data will remain.\n\n"
|
|
"[bold]Example: safety --disable-optional-telemetry scan[/bold]"
|
|
)
|
|
|
|
# Scan Help options
|
|
SCAN_POLICY_FILE_HELP = (
|
|
"Use a local policy file to configure the scan.\n\n"
|
|
"[nhc]Note: Project scan policies defined in Safety Platform will override local policy files[/nhc]\n\n"
|
|
"[bold]Example: safety scan --policy-file /path/to/policy.yml[/bold]"
|
|
)
|
|
SCAN_TARGET_HELP = (
|
|
"Define a specific project path to scan. (default: current directory)\n\n"
|
|
"[bold]Example: safety scan --target /path/to/project[/bold]"
|
|
)
|
|
SCAN_OUTPUT_HELP = (
|
|
"Set the output format for scan results (default: screen)\n\n"
|
|
"[bold]Example: safety scan --output json[/bold]"
|
|
)
|
|
SCAN_SAVE_AS_HELP = (
|
|
"In addition to regular output save the scan results to a json, html, text, or spdx file using: FORMAT FILE_PATH\n\n"
|
|
"[bold]Example: safety scan --save-as json results.json[/bold]"
|
|
)
|
|
SCAN_DETAILED_OUTPUT = (
|
|
"Enable a verbose scan report for detailed insights (only for screen output)\n\n"
|
|
"[bold]Example: safety scan --detailed-output[/bold]"
|
|
)
|
|
SCAN_APPLY_FIXES = (
|
|
"[bold]Update packages listed in requirements.txt files to secure versions where possible[/bold]\n\n"
|
|
"[nhc]Currently supports: requirements.txt files[/nhc]\n\n"
|
|
"Note: this will update your requirements.txt file "
|
|
)
|
|
|
|
# System Scan options
|
|
SYSTEM_SCAN_POLICY_FILE_HELP = (
|
|
"Use a local policy file to configure the scan.\n\n"
|
|
"[nhc]Note: Scan policies defined in Safety Platform will override local policy files[/nhc]\n\n"
|
|
"[bold]Example: safety scan --policy-file /path/to/policy.yml[/bold]"
|
|
)
|
|
SYSTEM_SCAN_TARGET_HELP = (
|
|
"Define a specific location to start the system scan. (default: current directory)\n\n"
|
|
"[bold]Example: safety scan --target /path/to/project[/bold]"
|
|
)
|
|
SYSTEM_SCAN_OUTPUT_HELP = (
|
|
"Set the output format for scan results (default: screen)\n\n"
|
|
"[bold]Example: safety scan --output json[/bold]"
|
|
)
|
|
SYSTEM_SCAN_SAVE_AS_HELP = (
|
|
"In addition to the terminal/console output (set by --output), save system-scan results to a screen (text) or json file.\n\n"
|
|
"""[nhc]Use [bold]--save-as <FORMAT> <PATH>[/bold]. For example: [bold]--save-as json my-machine-scan.json[/bold] to save the system-scan results to `my-machine-scan.json` in the current directory[/nhc]\n\n"""
|
|
"[nhc][Default: json .][/nhc]"
|
|
)
|
|
|
|
# Auth options
|
|
CLI_AUTH_LOGIN_HELP = (
|
|
"Authenticate with Safety CLI to perform scans. Your default browser will automatically open to https://platform.safetycli.com unless already authenticated.\n\n"
|
|
"[bold]Example: safety auth login[/bold]"
|
|
)
|
|
CLI_AUTH_LOGOUT_HELP = (
|
|
"Log out from the current Safety CLI session.\n\n"
|
|
"[bold]Example: safety auth logout[/bold]"
|
|
)
|
|
CLI_AUTH_STATUS_HELP = (
|
|
"Show the current authentication status.\n\n"
|
|
"[bold]Example: safety auth status[/bold]"
|
|
)
|
|
|
|
# Configure options
|
|
CLI_CONFIGURE_PROXY_HOST_HELP = "Specify a proxy host for network communications to be saved into Safety's configuration. \n\n"
|
|
CLI_CONFIGURE_PROXY_PORT_HELP = (
|
|
"Set the proxy port to be saved into Safety's configuration file (default: 80).\n\n"
|
|
)
|
|
CLI_CONFIGURE_PROXY_PROTOCOL_HELP = "Choose the proxy protocol to be saved into Safety's configuration file (default: https).\n\n"
|
|
CLI_CONFIGURE_PROXY_TIMEOUT = (
|
|
"Set the timeout duration for proxy network calls.\n\n"
|
|
+ "[bold]Example: safety configure --proxy-timeout 30[/bold]"
|
|
)
|
|
CLI_CONFIGURE_PROXY_REQUIRED = (
|
|
"Enable or disable the requirement for a proxy in network communications\n\n"
|
|
+ "[bold]Example: safety configure --proxy-required[/bold]"
|
|
)
|
|
CLI_CONFIGURE_ORGANIZATION_ID = (
|
|
"Set the current device with an organization ID."
|
|
" - see your Safety Platform Organization page\n\n"
|
|
+ "[bold]Example: safety configure --organization-id your_org_unique_id[/bold]"
|
|
)
|
|
CLI_CONFIGURE_ORGANIZATION_NAME = (
|
|
"Set the current device with an organization name."
|
|
" - see your Safety Platform Organization page.\n\n"
|
|
+ '[bold]Example: safety configure --organization-name "Your Org Name"[/bold]'
|
|
)
|
|
CLI_CONFIGURE_SAVE_TO_SYSTEM = (
|
|
"Save the configuration to a system config file.\n"
|
|
"This will configure Safety CLI for all users on this machine. Use --save-to-user to "
|
|
"configure Safety CLI for only your user.\n\n"
|
|
"[bold]Example: safety configure --save-to-system[/bold]"
|
|
)
|
|
|
|
# Generate options
|
|
CLI_GENERATE_PATH = (
|
|
"The path where the generated file will be saved (default: current directory).\n\n"
|
|
"[bold]Example: safety generate policy_file --path .my-project-safety-policy.yml[/bold]"
|
|
)
|
|
CLI_GENERATE_MINIMUM_CVSS_SEVERITY = (
|
|
"The minimum CVSS severity to generate the installation policy for.\n\n"
|
|
"[bold]Example: safety generate installation_policy --minimum-cvss-severity high[/bold]"
|
|
)
|
|
|
|
# Command default settings
|
|
CMD_PROJECT_NAME = "scan"
|
|
CMD_SYSTEM_NAME = "system-scan"
|
|
DEFAULT_CMD = CMD_PROJECT_NAME
|
|
DEFAULT_SPINNER = "bouncingBar"
|