1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-07-24 14:35:28 +02:00

uv-{add, tree}: Add page (#15552)

Co-authored-by: Wiktor Perskawiec <git@spageektti.cc>
This commit is contained in:
Damy Metzke 2025-01-22 14:10:36 +01:00 committed by GitHub
parent be660e028b
commit 0f59282916
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 69 additions and 4 deletions

37
pages/common/uv-add.md Normal file
View file

@ -0,0 +1,37 @@
# uv add
> Add package dependencies to the `pyproject.toml` file.
> Packages are specified according to <https://peps.python.org/pep-0508/>.
> More information: <https://docs.astral.sh/uv/reference/cli/#uv-add>.
- Add the latest version of a package:
`uv add {{package}}`
- Add multiple packages:
`uv add {{package1 package2 ...}}`
- Add a package with a version requirement:
`uv add {{package>=1.2.3}}`
- Add packages to an optional dependency group, which will be included when published:
`uv add --optional {{optional}} {{package1 package2 ...}}`
- Add packages to a local group, which will not be included when published:
`uv add --group {{group}} {{package1 package2 ...}}`
- Add packages to the dev group, shorthand for `--group dev`:
`uv add --dev {{package1 package2 ...}}`
- Add package as editable:
`uv add --editable {{path/to/package/}}`
- Enable an extra when installing package, may be provided multiple times:
`uv add {{package}} --extra {{extra_feature}}`

28
pages/common/uv-tree.md Normal file
View file

@ -0,0 +1,28 @@
# uv tree
> Display project dependencies in a tree format.
> More information: <https://docs.astral.sh/uv/reference/cli/#uv-tree>.
- Show dependency tree for current environment:
`uv tree`
- Show dependency tree for all environments:
`uv tree --universal`
- Show dependency tree up to a certain depth:
`uv tree {{-d|--depth}} {{n}}`
- Show the latest available version for all outdated packages:
`uv tree --outdated`
- Exclude dependencies from the dev group:
`uv tree --no-dev`
- Show the inverted tree, so children are dependents instead of dependencies:
`uv tree --invert`

View file

@ -8,15 +8,15 @@
`uv init`
- Create a new Python project in a directory with the given name:
- Create a new Python project at the specified path:
`uv init {{project_name}}`
`uv init {{path/to/directory}}`
- Add a new package to the project:
- Add a new dependency to the project:
`uv add {{package}}`
- Remove a package from the project:
- Remove a dependency from the project:
`uv remove {{package}}`