Skip to content

Commit 3eb375f

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update uv official documentation
1 parent 84a0e80 commit 3eb375f

File tree

19 files changed

+321
-100
lines changed

19 files changed

+321
-100
lines changed

src/assets/uv/_metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"source_repo": "astral-sh/uv",
33
"docs_path": "docs",
4-
"updated_at": "2025-11-11T22:05:55Z",
5-
"commit_sha": "63df2cdfe9017bc3f9575a7efb00ca5fdf9fb289"
4+
"updated_at": "2025-11-18T22:05:38Z",
5+
"commit_sha": "3ac43e8d15ff93405e305523d3a9abdd7670a627"
66
}

src/assets/uv/concepts/build-backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To use uv as a build backend in an existing project, add `uv_build` to the
3131

3232
```toml title="pyproject.toml"
3333
[build-system]
34-
requires = ["uv_build>=0.9.8,<0.10.0"]
34+
requires = ["uv_build>=0.9.10,<0.10.0"]
3535
build-backend = "uv_build"
3636
```
3737

src/assets/uv/concepts/configuration-files.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,14 @@ default = true
4242
`pyproject.toml` files are present in a directory, configuration will be read from `uv.toml`, and
4343
`[tool.uv]` section in the accompanying `pyproject.toml` will be ignored.
4444

45-
uv will also discover user-level configuration at `~/.config/uv/uv.toml` (or
46-
`$XDG_CONFIG_HOME/uv/uv.toml`) on macOS and Linux, or `%APPDATA%\uv\uv.toml` on Windows; and
47-
system-level configuration at `/etc/uv/uv.toml` (or `$XDG_CONFIG_DIRS/uv/uv.toml`) on macOS and
48-
Linux, or `%SYSTEMDRIVE%\ProgramData\uv\uv.toml` on Windows.
45+
uv will also discover `uv.toml` configuration files in the user- and system-level
46+
[configuration directories](../reference/storage.md#configuration-directories), e.g., user-level
47+
configuration in `~/.config/uv/uv.toml`, and system-level configuration at `/etc/uv/uv.toml` on
48+
macOS and Linux.
4949

50-
User-and system-level configuration must use the `uv.toml` format, rather than the `pyproject.toml`
51-
format, as a `pyproject.toml` is intended to define a Python _project_.
50+
!!! important
51+
52+
User- and system-level configuration files cannot use the `pyproject.toml` format.
5253

5354
If project-, user-, and system-level configuration files are found, the settings will be merged,
5455
with project-level configuration taking precedence over the user-level configuration, and user-level

src/assets/uv/concepts/preview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ The following preview features are available:
7474
[system-native location](../concepts/authentication/http.md#the-uv-credentials-store).
7575
- `workspace-metadata`: Allows using `uv workspace metadata`.
7676
- `workspace-dir`: Allows using `uv workspace dir`.
77+
- `workspace-list`: Allows using `uv workspace list`.
7778

7879
## Disabling preview features
7980

src/assets/uv/concepts/projects/init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ dependencies = []
113113
example-pkg = "example_pkg:main"
114114

115115
[build-system]
116-
requires = ["uv_build>=0.9.8,<0.10.0"]
116+
requires = ["uv_build>=0.9.10,<0.10.0"]
117117
build-backend = "uv_build"
118118
```
119119

@@ -136,7 +136,7 @@ dependencies = []
136136
example-pkg = "example_pkg:main"
137137

138138
[build-system]
139-
requires = ["uv_build>=0.9.8,<0.10.0"]
139+
requires = ["uv_build>=0.9.10,<0.10.0"]
140140
build-backend = "uv_build"
141141
```
142142

@@ -197,7 +197,7 @@ requires-python = ">=3.11"
197197
dependencies = []
198198

199199
[build-system]
200-
requires = ["uv_build>=0.9.8,<0.10.0"]
200+
requires = ["uv_build>=0.9.10,<0.10.0"]
201201
build-backend = "uv_build"
202202
```
203203

src/assets/uv/concepts/projects/workspaces.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ bird-feeder = { workspace = true }
7575
members = ["packages/*"]
7676

7777
[build-system]
78-
requires = ["uv_build>=0.9.8,<0.10.0"]
78+
requires = ["uv_build>=0.9.10,<0.10.0"]
7979
build-backend = "uv_build"
8080
```
8181

@@ -106,7 +106,7 @@ tqdm = { git = "https://github.com/tqdm/tqdm" }
106106
members = ["packages/*"]
107107

108108
[build-system]
109-
requires = ["uv_build>=0.9.8,<0.10.0"]
109+
requires = ["uv_build>=0.9.10,<0.10.0"]
110110
build-backend = "uv_build"
111111
```
112112

@@ -188,7 +188,7 @@ dependencies = ["bird-feeder", "tqdm>=4,<5"]
188188
bird-feeder = { path = "packages/bird-feeder" }
189189

190190
[build-system]
191-
requires = ["uv_build>=0.9.8,<0.10.0"]
191+
requires = ["uv_build>=0.9.10,<0.10.0"]
192192
build-backend = "uv_build"
193193
```
194194

src/assets/uv/concepts/python-versions.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,15 @@ present, uv will install all the Python versions listed in the file.
121121
The available Python versions are frozen for each uv release. To install new Python versions,
122122
you may need upgrade uv.
123123

124+
See the [storage documentation](../reference/storage.md#python-versions) for details about where
125+
installed Python versions are stored.
126+
124127
### Installing Python executables
125128

126-
uv installs Python executables into your `PATH` by default, e.g., `uv python install 3.12` will
127-
install a Python executable into `~/.local/bin`, e.g., as `python3.12`.
129+
uv installs Python executables into your `PATH` by default, e.g., on Unix `uv python install 3.12`
130+
will install a Python executable into `~/.local/bin`, e.g., as `python3.12`. See the
131+
[storage documentation](../reference/storage.md#python-executables) for more details about the
132+
target directory.
128133

129134
!!! tip
130135

src/assets/uv/concepts/tools.md

Lines changed: 19 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,14 @@ treated as disposable, i.e., if you run `uv cache clean` the environment will be
3535
environment is only cached to reduce the overhead of repeated invocations. If the environment is
3636
removed, a new one will be created automatically.
3737

38-
When installing a tool with `uv tool install`, a virtual environment is created in the uv tools
39-
directory. The environment will not be removed unless the tool is uninstalled. If the environment is
40-
manually deleted, the tool will fail to run.
38+
When installing a tool with `uv tool install`, a virtual environment is created in the
39+
[uv tools directory](../reference/storage.md#tools). The environment will not be removed unless the
40+
tool is uninstalled. If the environment is manually deleted, the tool will fail to run.
41+
42+
!!! important
43+
44+
Tool environments are _not_ intended to be mutated directly. It is strongly recommended never to
45+
mutate a tool environment manually, e.g., with a `pip` operation.
4146

4247
## Tool versions
4348

@@ -109,26 +114,6 @@ $ uv tool install ruff@latest
109114
$ uv tool install ruff@0.6.0
110115
```
111116

112-
## Tools directory
113-
114-
By default, the uv tools directory is named `tools` and is in the uv application state directory,
115-
e.g., `~/.local/share/uv/tools`. The location may be customized with the `UV_TOOL_DIR` environment
116-
variable.
117-
118-
To display the path to the tool installation directory:
119-
120-
```console
121-
$ uv tool dir
122-
```
123-
124-
Tool environments are placed in a directory with the same name as the tool package, e.g.,
125-
`.../tools/<name>`.
126-
127-
!!! important
128-
129-
Tool environments are _not_ intended to be mutated directly. It is strongly recommended never to
130-
mutate a tool environment manually, e.g., with a `pip` operation.
131-
132117
## Upgrading tools
133118

134119
Tool environments may be upgraded via `uv tool upgrade`, or re-created entirely via subsequent
@@ -259,35 +244,23 @@ tool may be unusable.
259244
## Tool executables
260245

261246
Tool executables include all console entry points, script entry points, and binary scripts provided
262-
by a Python package. Tool executables are symlinked into the `bin` directory on Unix and copied on
263-
Windows.
264-
265-
### The `bin` directory
266-
267-
Executables are installed into the user `bin` directory following the XDG standard, e.g.,
268-
`~/.local/bin`. Unlike other directory schemes in uv, the XDG standard is used on _all platforms_
269-
notably including Windows and macOS — there is no clear alternative location to place executables on
270-
these platforms. The installation directory is determined from the first available environment
271-
variable:
247+
by a Python package. Tool executables are symlinked into the
248+
[executable directory](../reference/storage.md#tool-executables) on Unix and copied on Windows.
272249

273-
- `$UV_TOOL_BIN_DIR`
274-
- `$XDG_BIN_HOME`
275-
- `$XDG_DATA_HOME/../bin`
276-
- `$HOME/.local/bin`
277-
278-
Executables provided by dependencies of tool packages are not installed.
250+
!!! note
279251

280-
### The `PATH`
252+
Executables provided by dependencies of tool packages are not installed.
281253

282-
The `bin` directory must be in the `PATH` variable for tool executables to be available from the
283-
shell. If it is not in the `PATH`, a warning will be displayed. The `uv tool update-shell` command
284-
can be used to add the `bin` directory to the `PATH` in common shell configuration files.
254+
The [executable directory](../reference/storage.md#executable-directory) must be in the `PATH`
255+
variable for tool executables to be available from the shell. If it is not in the `PATH`, a warning
256+
will be displayed. The `uv tool update-shell` command can be used to add the executable directory to
257+
the `PATH` in common shell configuration files.
285258

286259
### Overwriting executables
287260

288-
Installation of tools will not overwrite executables in the `bin` directory that were not previously
289-
installed by uv. For example, if `pipx` has been used to install a tool, `uv tool install` will
290-
fail. The `--force` flag can be used to override this behavior.
261+
Installation of tools will not overwrite executables in the executable directory that were not
262+
previously installed by uv. For example, if `pipx` has been used to install a tool,
263+
`uv tool install` will fail. The `--force` flag can be used to override this behavior.
291264

292265
## Relationship to `uv run`
293266

src/assets/uv/getting-started/installation.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ uv provides a standalone installer to download and install uv:
2525
Request a specific version by including it in the URL:
2626

2727
```console
28-
$ curl -LsSf https://astral.sh/uv/0.9.8/install.sh | sh
28+
$ curl -LsSf https://astral.sh/uv/0.9.10/install.sh | sh
2929
```
3030

3131
=== "Windows"
@@ -41,7 +41,7 @@ uv provides a standalone installer to download and install uv:
4141
Request a specific version by including it in the URL:
4242

4343
```pwsh-session
44-
PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.9.8/install.ps1 | iex"
44+
PS> powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.9.10/install.ps1 | iex"
4545
```
4646

4747
!!! tip
@@ -260,7 +260,8 @@ If you need to remove uv from your system, follow these steps:
260260

261261
!!! tip
262262

263-
Before removing the binaries, you may want to remove any data that uv has stored.
263+
Before removing the binaries, you may want to remove any data that uv has stored. See the
264+
[storage reference](../reference/storage.md) for details on where uv stores data.
264265

265266
2. Remove the uv, uvx, and uvw binaries:
266267

src/assets/uv/guides/integration/aws-lambda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ the second stage, we'll copy this directory over to the final image, omitting th
9292
other unnecessary files.
9393

9494
```dockerfile title="Dockerfile"
95-
FROM ghcr.io/astral-sh/uv:0.9.8 AS uv
95+
FROM ghcr.io/astral-sh/uv:0.9.10 AS uv
9696

9797
# First, bundle the dependencies into the task root.
9898
FROM public.ecr.aws/lambda/python:3.13 AS builder
@@ -334,7 +334,7 @@ And confirm that opening http://127.0.0.1:8000/ in a web browser displays, "Hell
334334
Finally, we'll update the Dockerfile to include the local library in the deployment package:
335335

336336
```dockerfile title="Dockerfile"
337-
FROM ghcr.io/astral-sh/uv:0.9.8 AS uv
337+
FROM ghcr.io/astral-sh/uv:0.9.10 AS uv
338338

339339
# First, bundle the dependencies into the task root.
340340
FROM public.ecr.aws/lambda/python:3.13 AS builder

0 commit comments

Comments
 (0)