Skip to content

Add SSH username to Git over SSH documentation example #11838

@WilliamDEdwards

Description

@WilliamDEdwards

Description

The documentation at https://pip.pypa.io/en/stable/topics/vcs-support/#git contains the following example:

MyProject @ git+ssh://git.example.com/MyProject

However, the line should contain a username:

MyProject @ git+ssh://git@git.example.com/MyProject

Expected behavior

No response

pip version

21.2.4

Python version

3.9.6

OS

macOS 12.5

How to Reproduce

  1. Run pip3 install 'MyProject @ git+ssh://git.example.com/MyProject' (without username)

Output

Without username:

(testvenv) williams-air:testvenv williamedwards$ pip3 install 'foobar @ git+ssh://example.com/foobar'
    fatal: '/foobar' does not appear to be a git repository
    fatal: Could not read from remote repository.

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueA good item for first time contributors to work onstate: awaiting PRFeature discussed, PR is neededtype: docsDocumentation related

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions