# Available Commands and Inputs The available commands and options within Safety CLI Scanner are detailed below. These can also be found within Safety CLI by typing `safety --help` or `safety [command] --help`. ## Authentication
safety auth --helpCommand/OptionDescription
CommandsloginAuthenticate with Safety CLI to perform scans. Your default browser will automatically open to https://platform.safetycli.com unless already authenticated.
Example: safety auth login
logoutLog out from the current Safety CLI session.
Example: safety auth logout
statusShow the current authentication status.
Example: safety auth status
Options--install-completionInstall shell-specific completion scripts.
Example: safety auth --install-completion fish
--show-completionShow shell completion scripts for manual setup.
Example: safety auth --show-completion fish
--helpShow detailed help information for commands and options.
Example: safety auth --help
## Commands
safety --helpCommand/OptionDescription
CommandsauthAuthenticate Safety CLI to perform scans. Your default browser will automatically open to https://platform.safetycli.com.
Example: safety auth login
scanRun vulnerability scans on a Python project directory.
Example: safety scan
system-scanRun a comprehensive scan for packages and vulnerabilities across your entire machine/environment.
Example: safety system-scan
Other Commandsalert[Deprecated] Create GitHub Pull Requests from scan results. Being replaced by newer features.
Example: safety alert
check[Deprecated] Find vulnerabilities in target files/environments. Now replaced by safety scan.
Example: safety check /path/to/requirements.txt
check-updatesCheck for updates to the Safety CLI.
Example: safety check-updates
configureSet up global configurations for Safety CLI, including proxy settings and organization details.
Example: safety configure --proxy-host 192.168.0.1
generateGenerate a standard Safety CLI policy file to establish baseline policies for scans.
Example: safety generate policy_file
validateCheck if your local Safety CLI policy file is valid.
Example: safety validate /path/to/policy.yml
Options--stageAssign a development lifecycle stage to your scan (default: development).
Example: safety --stage production scan
--keyUse an API key for scans in CI/CD or Production (default: none).
For Development scans, unset the API key and authenticate using safety auth.
Example: safety --key 'your_api_key' scan
--proxy-hostSpecify a proxy host for network communications.
Example: safety configure --proxy-host 'proxy.example.com'
--proxy-portSet the proxy port (default: 80).
Note: proxy details can be set globally in a config file. See safety configure --help.
Example: safety configure --proxy-port 8080
--proxy-protocolChoose the proxy protocol (default: https).
Note: proxy details can be set globally in a config file. See safety configure --help.
Example: safety configure --proxy-protocol https
--disable-optional-telemetry-dataOpt-out of sending optional telemetry for privacy. Anonymized telemetry data will remain.
Example: safety --disable-optional-telemetry-data scan
--debugEnable debug mode for detailed output in addition to standard output.
Example: safety --debug scan
--versionDisplay the installed version of Safety CLI.
Example: safety --version
--helpShow detailed help information for commands and options.
Example: safety --help
## Safety Scan Options
safety scan --helpCommand/OptionDescription
Options--targetDefine a specific project path for scanning.
Example: safety scan --target /path/to/project
--outputSet the format for scan results (default: screen) using Screen, JSON, HTML, or SPDX.
Example: safety scan --output json
--detailed-outputEnable a verbose scan report for detailed insights.
Example: safety scan --detailed-output
--save-asSave scan results in different formats, including text, json, html, and spdx.
Example: safety scan --save-as json results.json
--policy-fileUse a local policy file for scanning.
Example: safety scan --policy-file /path/to/policy.yml
--install-completionInstall command-line completion for easier use.
Example: safety --install-completion bash
--show-completionDisplay shell completion scripts for customization.
Example: safety --show-completion zsh
--apply-fixesAutomatically apply updates to requirements files for identified vulnerabilities in accordance with the parameters set in the config file.
Example: safety scan --apply-fixes
## Environment Variables | Env Var | Default Value | Description | | ------------------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SAFETY\_REQUEST\_TIMEOUT | 30 seconds | Allows setting a custom request timeout for Safety CLI when pulling vulnerability and license JSON data from servers. If set, this value takes priority over the default hardcoded value. | | | | | | | | | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.safetycli.com/safety-docs/safety-cli/scanning-for-vulnerable-and-malicious-packages/available-commands-and-inputs.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.