Pipenv CLI Reference¶
pipenv¶
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.
-
--completion
¶
Output completion (to be eval'd).
-
--man
¶
Display manpage.
-
--support
¶
Output diagnostic information for use in GitHub issues.
-
--site-packages
,
--no-site-packages
¶
Enable site-packages for the virtualenv.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
-
--version
¶
Show the version and exit.
check¶
Checks for security vulnerabilities and against PEP 508 markers provided in Pipfile.
pipenv check [OPTIONS] [ARGS]...
Options
-
--unused
<unused>
¶ Given a code path, show potentially unused dependencies.
-
-i
,
--ignore
<ignore>
¶ Ignore specified vulnerability during safety checks.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
-
--system
¶
System pip management.
Arguments
-
ARGS
¶
Optional argument(s)
clean¶
Uninstalls all packages not specified in Pipfile.lock.
pipenv clean [OPTIONS]
Options
-
--bare
¶
Minimal output.
-
--dry-run
¶
Just output unneeded packages.
-
-v
,
--verbose
¶
Verbose mode.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
graph¶
Displays currently-installed dependency graph information.
pipenv graph [OPTIONS]
Options
-
--bare
¶
Minimal output.
-
--json
¶
Output JSON.
-
--json-tree
¶
Output JSON in nested tree.
-
--reverse
¶
Reversed dependency graph.
install¶
Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.
pipenv install [OPTIONS] [PACKAGES]...
Options
-
--system
¶
System pip management.
-
-c
,
--code
<code>
¶ Install packages automatically discovered from import statements.
-
--deploy
¶
Abort if the Pipfile.lock is out-of-date, or Python version is wrong.
-
--site-packages
,
--no-site-packages
¶
Enable site-packages for the virtualenv.
-
--skip-lock
¶
Skip locking mechanisms and use the Pipfile instead during operation.
-
-e
,
--editable
<editable>
¶ An editable python package URL or path, often to a VCS repo.
-
--ignore-pipfile
¶
Ignore Pipfile when installing, using the Pipfile.lock.
-
--selective-upgrade
¶
Update specified packages.
-
-r
,
--requirements
<requirements>
¶ Import a requirements.txt file.
-
--extra-index-url
<extra_index_url>
¶ URLs to the extra PyPI compatible indexes to query for package lookups.
-
-i
,
--index
<index>
¶ Target PyPI-compatible package index url.
-
--sequential
¶
Install dependencies one-at-a-time, instead of concurrently.
-
--keep-outdated
¶
Keep out-dated dependencies from being updated in Pipfile.lock.
-
--pre
¶
Allow pre-releases.
-
-d
,
--dev
¶
Install both develop and default packages.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
Arguments
-
PACKAGES
¶
Optional argument(s)
Environment variables
-
PIPENV_SKIP_LOCK
¶ Provide a default for
--skip-lock
-
PIP_EXTRA_INDEX_URL
¶ Provide a default for
--extra-index-url
lock¶
Generates Pipfile.lock.
pipenv lock [OPTIONS]
Options
-
-r
,
--requirements
¶
Generate output in requirements.txt format.
-
--keep-outdated
¶
Keep out-dated dependencies from being updated in Pipfile.lock.
-
--pre
¶
Allow pre-releases.
-
-d
,
--dev
¶
Install both develop and default packages.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
open¶
View a given module in your editor.
This uses the EDITOR environment variable. You can temporarily override it, for example:
EDITOR=atom pipenv open requests
pipenv open [OPTIONS] MODULE
Options
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
Arguments
-
MODULE
¶
Required argument
run¶
Spawns a command installed into the virtualenv.
pipenv run [OPTIONS] COMMAND [ARGS]...
Options
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
Arguments
-
COMMAND
¶
Required argument
-
ARGS
¶
Optional argument(s)
shell¶
Spawns a shell within the virtualenv.
pipenv shell [OPTIONS] [SHELL_ARGS]...
Options
-
--fancy
¶
Run in shell in fancy mode. Make sure the shell have no path manipulating scripts. Run $pipenv shell for issues with compatibility mode.
-
--anyway
¶
Always spawn a subshell, even if one is already spawned.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
Arguments
-
SHELL_ARGS
¶
Optional argument(s)
sync¶
Installs all packages specified in Pipfile.lock.
pipenv sync [OPTIONS]
Options
-
--bare
¶
Minimal output.
-
--sequential
¶
Install dependencies one-at-a-time, instead of concurrently.
-
--keep-outdated
¶
Keep out-dated dependencies from being updated in Pipfile.lock.
-
--pre
¶
Allow pre-releases.
-
-d
,
--dev
¶
Install both develop and default packages.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
uninstall¶
Un-installs a provided package and removes it from Pipfile.
pipenv uninstall [OPTIONS] [PACKAGES]...
Options
-
--all-dev
¶
Un-install all package from [dev-packages].
-
--all
¶
Purge all package(s) from virtualenv. Does not edit Pipfile.
-
-e
,
--editable
<editable>
¶ An editable python package URL or path, often to a VCS repo.
-
--skip-lock
¶
Skip locking mechanisms and use the Pipfile instead during operation.
-
--keep-outdated
¶
Keep out-dated dependencies from being updated in Pipfile.lock.
-
--pre
¶
Allow pre-releases.
-
-d
,
--dev
¶
Install both develop and default packages.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
Arguments
-
PACKAGES
¶
Optional argument(s)
Environment variables
-
PIPENV_SKIP_LOCK
¶ Provide a default for
--skip-lock
update¶
Runs lock, then sync.
pipenv update [OPTIONS] [PACKAGES]...
Options
-
--bare
¶
Minimal output.
-
--outdated
¶
List out-of-date dependencies.
-
--dry-run
¶
List out-of-date dependencies.
-
-e
,
--editable
<editable>
¶ An editable python package URL or path, often to a VCS repo.
-
--ignore-pipfile
¶
Ignore Pipfile when installing, using the Pipfile.lock.
-
--selective-upgrade
¶
Update specified packages.
-
-r
,
--requirements
<requirements>
¶ Import a requirements.txt file.
-
--extra-index-url
<extra_index_url>
¶ URLs to the extra PyPI compatible indexes to query for package lookups.
-
-i
,
--index
<index>
¶ Target PyPI-compatible package index url.
-
--sequential
¶
Install dependencies one-at-a-time, instead of concurrently.
-
--keep-outdated
¶
Keep out-dated dependencies from being updated in Pipfile.lock.
-
--pre
¶
Allow pre-releases.
-
-d
,
--dev
¶
Install both develop and default packages.
-
--python
<python>
¶ Specify which version of Python virtualenv should use.
-
--three
,
--two
¶
Use Python 3/2 when creating virtualenv.
-
--clear
¶
Clears caches (pipenv, pip, and pip-tools).
-
-v
,
--verbose
¶
Verbose mode.
-
--pypi-mirror
<pypi_mirror>
¶ Specify a PyPI mirror.
Arguments
-
PACKAGES
¶
Optional argument(s)
Environment variables
-
PIP_EXTRA_INDEX_URL
¶ Provide a default for
--extra-index-url