You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Just a small PR to add mentions to `pylock.toml` in the CLI manual where
appropriate.
I tried to say "PEP-751 compatible lock files" when appropriate to also
include the case `r"^pylock\.([^.]+)\.toml$"`. Feel free to change that
if you think it's cluttery.
I also tried to include the "single-use" wording when it made sense.
I also have almost never used the `uv pip` interface, so maybe there are
some other minor things to add here and there about the usage of
`pylock.toml` that I missed.
---------
Co-authored-by: Charlie Marsh <[email protected]>
Copy file name to clipboardExpand all lines: docs/reference/cli.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2214,7 +2214,7 @@ uv lock [OPTIONS]
2214
2214
2215
2215
Export the project's lockfile to an alternate format.
2216
2216
2217
-
At present, only `requirements-txt` is supported.
2217
+
At present, both `requirements.txt` and `pylock.toml` (PEP 751) formats are supported.
2218
2218
2219
2219
The project is re-locked before exporting unless the `--locked` or `--frozen` flag is provided.
2220
2220
@@ -5553,9 +5553,9 @@ uv pip [OPTIONS] <COMMAND>
5553
5553
5554
5554
<h3 class="cli-reference">Commands</h3>
5555
5555
5556
-
<dl class="cli-reference"><dt><a href="#uv-pip-compile"><code>uv pip compile</code></a></dt><dd><p>Compile a <code>requirements.in</code> file to a <code>requirements.txt</code> file</p>
5556
+
<dl class="cli-reference"><dt><a href="#uv-pip-compile"><code>uv pip compile</code></a></dt><dd><p>Compile a <code>requirements.in</code> file to a <code>requirements.txt</code> or <code>pylock.toml</code> file</p>
5557
5557
</dd>
5558
-
<dt><a href="#uv-pip-sync"><code>uv pip sync</code></a></dt><dd><p>Sync an environment with a <code>requirements.txt</code> file</p>
5558
+
<dt><a href="#uv-pip-sync"><code>uv pip sync</code></a></dt><dd><p>Sync an environment with a <code>requirements.txt</code> or <code>pylock.toml</code> file</p>
5559
5559
</dd>
5560
5560
<dt><a href="#uv-pip-install"><code>uv pip install</code></a></dt><dd><p>Install packages into an environment</p>
5561
5561
</dd>
@@ -5575,7 +5575,7 @@ uv pip [OPTIONS] <COMMAND>
5575
5575
5576
5576
### uv pip compile
5577
5577
5578
-
Compile a `requirements.in` file to a `requirements.txt` file
5578
+
Compile a `requirements.in` file to a `requirements.txt` or `pylock.toml` file
Sync an environment with a `requirements.txt` file.
6144
+
Sync an environment with a `requirements.txt` or `pylock.toml` file.
6145
6145
6146
-
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.
6146
+
When syncing an environment, any packages not listed in the `requirements.txt` or `pylock.toml` file will be removed. To retain extraneous packages, use `uv pip install` instead.
6147
6147
6148
-
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.
6148
+
The input 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.
<p>May also be set with the <code>UV_REQUIRE_HASHES</code> environment variable.</p>
7053
-
</dd><dt id="uv-pip-install--requirements"><a href="#uv-pip-install--requirements"><code>--requirements</code></a>, <code>--requirement</code>, <code>-r</code> <i>requirements</i></dt><dd><p>Install all packages listed in the given <code>requirements.txt</code> files.</p>
7053
+
</dd><dt id="uv-pip-install--requirements"><a href="#uv-pip-install--requirements"><code>--requirements</code></a>, <code>--requirement</code>, <code>-r</code> <i>requirements</i></dt><dd><p>Install all packages listed in the given <code>requirements.txt</code> or <code>pylock.toml</code> files.</p>
7054
7054
7055
7055
<p>If a <code>pyproject.toml</code>, <code>setup.py</code>, or <code>setup.cfg</code> file is provided, uv will extract the requirements for the relevant project.</p>
0 commit comments