Skip to content

Correct check/scan command documentation #6398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2025
Merged

Correct check/scan command documentation #6398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Bug Fixes
- Update ``check`` command to support the new ``scan`` functionality
---------------------------------------------------------------

The ``check`` command has been deprecated and will be unsupported beyond June 1, 2024.
The ``check`` command has been deprecated and will be unsupported beyond June 1, 2025.
Instead of adding a separate ``scan`` command, we've updated the ``check`` command to include a ``--scan`` option.

Key changes:
Expand Down
2 changes: 1 addition & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Options:
--scan Use the new scan command instead of the deprecated check command.
```

**Note**: The check command is deprecated and will be unsupported beyond 01 June 2024. In future versions, the check command will run the scan command by default. Use the `--scan` option to run the new scan command now.
**Note**: The check command is deprecated and will be unsupported beyond 01 June 2025. In future versions, the check command will run the scan command by default. Use the `--scan` option to run the new scan command now.

When using the `--scan` option, you'll need to obtain an API key from https://pyup.io to access the full vulnerability database.

Expand Down
9 changes: 1 addition & 8 deletions docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,7 @@ The user can provide these additional parameters:
The user can provide these additional parameters:

--auto-install — Automatically install safety if not already installed.

## scan

``$ pipenv scan`` scans for security vulnerabilities and checks PEP 508 markers. This is the newer version of the check command with improved functionality.

The user can provide these additional parameters:

--auto-install — Automatically install safety if not already installed.
--scan - Enable the newer version of the check command with improved functionality.

## scripts
``$ pipenv scripts`` will list the scripts in the current environment config.
3 changes: 1 addition & 2 deletions pipenv/cli/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,8 +530,7 @@ def check(
):
"""DEPRECATED: Checks for PyUp Safety security vulnerabilities and against PEP 508 markers provided in Pipfile.

This command has been deprecated and will be unsupported beyond 01 June 2024.
Please use the 'scan' command instead, which is easier to use and more powerful.
This command has been deprecated and will be replaced beyond 01 June 2025.

Use the --scan option to run the new scan command instead of the deprecated check command.
In future versions, the check command will run the scan command by default.
Expand Down