Clarify adding SSH Git dependencies (#13534)

The current instructions say 

> prefix a Git-compatible URL (i.e., that you would use with git clone)
with git+.

But this does not work with the URL that Github gives you when you
choose Clone -> SSH via the UI, which is of the form
`git@github.com:astral-sh/uv.git`. If you prefix this with `git+`, i.e.

`git+git@github.com:astral-sh/uv.git`

it does not work.

---------

Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
This commit is contained in:
Art O Cathain 2025-05-20 15:20:15 +01:00 committed by GitHub
parent 9e09482647
commit 1bee9320f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 2 deletions

View File

@ -270,13 +270,16 @@ explicit = true
### Git ### Git
To add a Git dependency source, prefix a Git-compatible URL (i.e., that you would use with To add a Git dependency source, prefix a Git-compatible URL with `git+`.
`git clone`) with `git+`.
For example: For example:
```console ```console
$ # Install over HTTP(S).
$ uv add git+https://github.com/encode/httpx $ uv add git+https://github.com/encode/httpx
$ # Install over SSH.
$ uv add git+ssh://git@github.com/encode/httpx
``` ```
```toml title="pyproject.toml" hl_lines="5" ```toml title="pyproject.toml" hl_lines="5"