.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "PIP-LOCK" "1" "May 02, 2025" "25.1" "pip" .SH NAME pip-lock \- description of pip lock command .SH DESCRIPTION .sp EXPERIMENTAL \- Lock packages and their dependencies from: .INDENT 0.0 .IP \(bu 2 PyPI (and other indexes) using requirement specifiers. .IP \(bu 2 VCS project urls. .IP \(bu 2 Local project directories. .IP \(bu 2 Local or remote source archives. .UNINDENT .sp pip also supports locking from \(dqrequirements files\(dq, which provide an easy way to specify a whole environment to be installed. .sp The generated lock file is only guaranteed to be valid for the current python version and platform. .SH USAGE .INDENT 0.0 .INDENT 3.5 .sp .EX python \-m pip lock [options] [\-e] ... python \-m pip lock [options] [package\-index\-options] ... python \-m pip lock [options] \-r [package\-index\-options] ... python \-m pip lock [options] ... .EE .UNINDENT .UNINDENT .SH OPTIONS .sp .INDENT 0.0 .TP .B \-o, \-\-output Lock file name (default=pylock.toml). Use \- for stdout. .sp (environment variable: \fBPIP_OUTPUT\fP) .UNINDENT .INDENT 0.0 .TP .B \-r, \-\-requirement Install from the given requirements file. This option can be used multiple times. .sp (environment variable: \fBPIP_REQUIREMENT\fP) .UNINDENT .INDENT 0.0 .TP .B \-c, \-\-constraint Constrain versions using the given constraints file. This option can be used multiple times. .sp (environment variable: \fBPIP_CONSTRAINT\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-no\-deps Don\(aqt install package dependencies. .sp (environment variable: \fBPIP_NO_DEPS\fP, \fBPIP_NO_DEPENDENCIES\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-pre Include pre\-release and development versions. By default, pip only finds stable versions. .sp (environment variable: \fBPIP_PRE\fP) .UNINDENT .INDENT 0.0 .TP .B \-e, \-\-editable Install a project in editable mode (i.e. setuptools \(dqdevelop mode\(dq) from a local project path or a VCS url. .sp (environment variable: \fBPIP_EDITABLE\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-src Directory to check out editable projects into. The default in a virtualenv is \(dq/src\(dq. The default for global installs is \(dq/src\(dq. .sp (environment variable: \fBPIP_SRC\fP, \fBPIP_SOURCE\fP, \fBPIP_SOURCE_DIR\fP, \fBPIP_SOURCE_DIRECTORY\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-ignore\-requires\-python Ignore the Requires\-Python information. .sp (environment variable: \fBPIP_IGNORE_REQUIRES_PYTHON\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-no\-build\-isolation Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used. .sp (environment variable: \fBPIP_NO_BUILD_ISOLATION\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-use\-pep517 Use PEP 517 for building source distributions (use \-\-no\-use\-pep517 to force legacy behaviour). .sp (environment variable: \fBPIP_USE_PEP517\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-check\-build\-dependencies Check the build dependencies when PEP517 is used. .sp (environment variable: \fBPIP_CHECK_BUILD_DEPENDENCIES\fP) .UNINDENT .INDENT 0.0 .TP .B \-C, \-\-config\-settings Configuration settings to be passed to the PEP 517 build backend. Settings take the form KEY=VALUE. Use multiple \-\-config\-settings options to pass multiple keys to the backend. .sp (environment variable: \fBPIP_CONFIG_SETTINGS\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-no\-binary Do not use binary packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either \(dq:all:\(dq to disable all binary packages, \(dq:none:\(dq to empty the set (notice the colons), or one or more package names with commas between them (no colons). Note that some packages are tricky to compile and may fail to install when this option is used on them. .sp (environment variable: \fBPIP_NO_BINARY\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-only\-binary Do not use source packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either \(dq:all:\(dq to disable all source packages, \(dq:none:\(dq to empty the set, or one or more package names with commas between them. Packages without binary distributions will fail to install when this option is used on them. .sp (environment variable: \fBPIP_ONLY_BINARY\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-prefer\-binary Prefer binary packages over source packages, even if the source packages are newer. .sp (environment variable: \fBPIP_PREFER_BINARY\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-require\-hashes Require a hash to check each requirement against, for repeatable installs. This option is implied when any package in a requirements file has a \-\-hash option. .sp (environment variable: \fBPIP_REQUIRE_HASHES\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-progress\-bar Specify whether the progress bar should be used [on, off, raw] (default: on) .sp (environment variable: \fBPIP_PROGRESS_BAR\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-group <[path:]group> Install a named dependency\-group from a \(dqpyproject.toml\(dq file. If a path is given, the name of the file must be \(dqpyproject.toml\(dq. Defaults to using \(dqpyproject.toml\(dq in the current directory. .sp (environment variable: \fBPIP_GROUP\fP) .UNINDENT .INDENT 0.0 .TP .B \-\-no\-clean Don\(aqt clean up build directories. .sp (environment variable: \fBPIP_NO_CLEAN\fP) .UNINDENT .SH AUTHOR pip developers .SH COPYRIGHT The pip developers .\" Generated by docutils manpage writer. .