Skip to content

Commit

Permalink
Update docs/concepts/projects.md
Browse files Browse the repository at this point in the history
Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
  • Loading branch information
zanieb and charliermarsh committed Sep 3, 2024
1 parent c28f54d commit 4d746ab
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/concepts/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,15 +279,16 @@ use [`uvx`](../guides/tools.md) or

### Custom project environment paths

The `UV_PROJECT_ENVIRONMENT` environment variable can be used to configure the path to virtual
environments in projects. If a relative path is provided, it will be resolved relative to the
workspace root.
The `UV_PROJECT_ENVIRONMENT` environment variable can be used to configure the project virtual
environment path (`.venv` by default).

If an environment is not present at the given path, uv will create it.
If a relative path is provided, it will be resolved relative to the workspace root. If an absolute
path is provided, it will be used as-is, i.e. a child directory will not be created for the
environment. If an environment is not present at the provided path, uv will create it.

This option can be used to write to the system Python environment, though it is not recommended.
`uv sync` will remove extraneous packages from the environment by default, which means if there are
installed packages relevant to the operation of the system, the system may be broken.
`uv sync` will remove extraneous packages from the environment by default and, as such, may leave
the system in a broken state.

!!! important

Expand Down

0 comments on commit 4d746ab

Please sign in to comment.