Commit 529c5985 by atanas argirov Committed by GitHub

* added additional description for poetry add covering git+ssh URL use cases (#3521)

parent 6cd4e05e
...@@ -215,6 +215,10 @@ or use ssh instead of https: ...@@ -215,6 +215,10 @@ or use ssh instead of https:
```bash ```bash
poetry add git+ssh://git@github.com/sdispater/pendulum.git poetry add git+ssh://git@github.com/sdispater/pendulum.git
or alternatively:
poetry add git+ssh://git@github.com:sdispater/pendulum.git
``` ```
If you need to checkout a specific branch, tag or revision, If you need to checkout a specific branch, tag or revision,
...@@ -223,6 +227,11 @@ you can specify it when using `add`: ...@@ -223,6 +227,11 @@ you can specify it when using `add`:
```bash ```bash
poetry add git+https://github.com/sdispater/pendulum.git#develop poetry add git+https://github.com/sdispater/pendulum.git#develop
poetry add git+https://github.com/sdispater/pendulum.git#2.0.5 poetry add git+https://github.com/sdispater/pendulum.git#2.0.5
or using SSH instead:
poetry add git+ssh://github.com/sdispater/pendulum.git#develop
poetry add git+ssh://github.com/sdispater/pendulum.git#2.0.5
``` ```
or make them point to a local directory or file: or make them point to a local directory or file:
......
...@@ -59,6 +59,8 @@ class AddCommand(InstallerCommand, InitCommand): ...@@ -59,6 +59,8 @@ class AddCommand(InstallerCommand, InitCommand):
" - A name and a constraint (<b>requests@^2.23.0</b>)\n" " - A name and a constraint (<b>requests@^2.23.0</b>)\n"
" - A git url (<b>git+https://github.com/python-poetry/poetry.git</b>)\n" " - A git url (<b>git+https://github.com/python-poetry/poetry.git</b>)\n"
" - A git url with a revision (<b>git+https://github.com/python-poetry/poetry.git#develop</b>)\n" " - A git url with a revision (<b>git+https://github.com/python-poetry/poetry.git#develop</b>)\n"
" - A git SSH url (<b>git+ssh://github.com/python-poetry/poetry.git</b>)\n"
" - A git SSH url with a revision (<b>git+ssh://github.com/python-poetry/poetry.git#develop</b>)\n"
" - A file path (<b>../my-package/my-package.whl</b>)\n" " - A file path (<b>../my-package/my-package.whl</b>)\n"
" - A directory (<b>../my-package/</b>)\n" " - A directory (<b>../my-package/</b>)\n"
" - A url (<b>https://example.com/packages/my-package-0.1.0.tar.gz</b>)\n" " - A url (<b>https://example.com/packages/my-package-0.1.0.tar.gz</b>)\n"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment