Skip to content
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.

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

README.md: mismatch with output from $ pipenv #5213

Closed
dqkqd opened this issue Jul 31, 2022 · 0 comments · Fixed by #5223
Closed

README.md: mismatch with output from $ pipenv #5213

dqkqd opened this issue Jul 31, 2022 · 0 comments · Fixed by #5223
Labels
Type: Documentation 📖 This issue relates to documentation of pipenv.

Comments

@dqkqd
Copy link
Contributor

dqkqd commented Jul 31, 2022

Issue description

There are differences between output of $ pipenv and usage written in README.md.
For example Python version (3.9 and 3.7) in Usage Example.

--- from_readme
+++ from_cli
@@ -1,23 +1,33 @@
 Usage: pipenv [OPTIONS] COMMAND [ARGS]...
 
 Options:
-  --where          Output project home information.
-  --venv           Output virtualenv information.
-  --py             Output Python interpreter information.
-  --envs           Output Environment Variable options.
-  --rm             Remove the virtualenv.
-  --bare           Minimal output.
-  --man            Display manpage.
-  --three          Use Python 3 when creating virtualenv.
-  --python TEXT    Specify which version of Python virtualenv should use.
-  --site-packages  Enable site-packages for the virtualenv.
-  --version        Show the version and exit.
-  -h, --help       Show this message and exit.
+  --where                         Output project home information.
+  --venv                          Output virtualenv information.
+  --py                            Output Python interpreter information.
+  --envs                          Output Environment Variable options.
+  --rm                            Remove the virtualenv.
+  --bare                          Minimal output.
+  --man                           Display manpage.
+  --support                       Output diagnostic information for use in
+                                  GitHub issues.
+  --site-packages / --no-site-packages
+                                  Enable site-packages for the virtualenv.
+                                  [env var: PIPENV_SITE_PACKAGES]
+  --python TEXT                   Specify which version of Python virtualenv
+                                  should use.
+  --three                         Use Python 3 when creating virtualenv.
+  --clear                         Clears caches (pipenv, pip).  [env var:
+                                  PIPENV_CLEAR]
+  -q, --quiet                     Quiet mode.
+  -v, --verbose                   Verbose mode.
+  --pypi-mirror TEXT              Specify a PyPI mirror.
+  --version                       Show the version and exit.
+  -h, --help                      Show this message and exit.
 
 
 Usage Examples:
-   Create a new project using Python 3.9, specifically:
-   $ pipenv --python 3.9
+   Create a new project using Python 3.7, specifically:
+   $ pipenv --python 3.7
 
    Remove project virtualenv (inferred from current directory):
    $ pipenv --rm
@@ -40,23 +50,20 @@
    Use a lower-level pip command:
    $ pipenv run pip freeze
 
-   Generate a requirements.txt file (including dev):
-   $ pipenv requirements --dev > requirements.txt
-
 Commands:
-  check         Checks for security vulnerabilities and against PEP 508 markers
-                provided in Pipfile.
+  check         Checks for PyUp Safety security vulnerabilities and against
+                PEP 508 markers provided in Pipfile.
   clean         Uninstalls all packages not specified in Pipfile.lock.
-  graph         Displays currently–installed dependency graph information.
+  graph         Displays currently-installed dependency graph information.
   install       Installs provided packages and adds them to Pipfile, or (if no
                 packages are given), installs all packages from Pipfile.
   lock          Generates Pipfile.lock.
   open          View a given module in your editor.
+  requirements  Generate a requirements.txt from Pipfile.lock.
   run           Spawns a command installed into the virtualenv.
-  scripts       Displays the shortcuts in the (optional) [scripts] section of
-                Pipfile.
+  scripts       Lists scripts in current environment config.
   shell         Spawns a shell within the virtualenv.
   sync          Installs all packages specified in Pipfile.lock.
-  requirements  Generates a requirements.txt compatible output directly from Pipfile.lock
-  uninstall     Un-installs a provided package and removes it from Pipfile.
-
+  uninstall     Uninstalls a provided package and removes it from Pipfile.
+  update        Runs lock, then sync.
+  verify        Verify the hash in Pipfile.lock is up-to-date.

Steps to replicate

$ pipenv


Please run $ pipenv --support, and paste the results here. Don't put backticks (`) around it! The output already contains Markdown formatting.

@matteius matteius added the Type: Documentation 📖 This issue relates to documentation of pipenv. label Aug 3, 2022
@oz123 oz123 mentioned this issue Aug 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation 📖 This issue relates to documentation of pipenv.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants