Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Extend the reference documentation for `uv pip sync` (#12683) 

See https://github.com/astral-sh/uv/issues/12680
This commit is contained in:
Zanie Blue 2025-04-07 17:40:26 -05:00 committed by GitHub
parent a0f5c7250b
commit 8ea34b56a1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/uv-cli/src/lib.rs
View File

@ -625,6 +625,14 @@ pub enum PipCommand {
)] )]
Compile(PipCompileArgs), Compile(PipCompileArgs),
/// Sync an environment with a `requirements.txt` file. /// Sync an environment with a `requirements.txt` file.
///
/// When syncing an environment, any packages not listed in the `requirements.txt` file will
/// be removed. To retain extraneous packages, use `uv pip install` instead.
///
/// The `requirements.txt` file is presumed to be the output of a `pip compile` or `uv export`
/// operation, in which it will include all transitive dependencies. If transitive dependencies
/// are not present in the file, they will not be installed. Use `--strict` to warn if any
/// transitive dependencies are missing.
#[command( #[command(
after_help = "Use `uv help pip sync` for more details.", after_help = "Use `uv help pip sync` for more details.",
after_long_help = "" after_long_help = ""

6
docs/reference/cli.md
View File

@ -6111,7 +6111,11 @@ uv pip compile [OPTIONS] <SRC_FILE|--group <GROUP>>
### uv pip sync ### uv pip sync
Sync an environment with a `requirements.txt` file Sync an environment with a `requirements.txt` file.
When syncing an environment, any packages not listed in the `requirements.txt` file will be removed. To retain extraneous packages, use `uv pip install` instead.
The `requirements.txt` file is presumed to be the output of a `pip compile` or `uv export` operation, in which it will include all transitive dependencies. If transitive dependencies are not present in the file, they will not be installed. Use `--strict` to warn if any transitive dependencies are missing.
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>