Docs: install instructions - add tip to quote package name w/ extras

mahiki commented 1 month ago

Before Proceeding, please acknowledge:

[x] I have consulted the Troubleshooting guide.
[x] I have searched Issues and Discussions in this repo.
[x] Feature requests should be initiated as Discussions. This is a bug report.

Describe the bug PIPX install - Its only the docs that need mention of install syntax for zsh:

pipx install harlequin[trino,s3]
# zsh: no matches found: harlequin[trino,s3]

pipx install 'harlequin[trino,s3]'
#  installed package harlequin 1.20.0, installed using Python 3.12.3
#  These apps are now globally available
#   - harlequin
# done! ✨ 🌟 ✨

I know its sort of a pipx thing but I spent a bit of time trying to understand my install problem.

If you just close this issue a google search will show the way, sorry I don't have time to post a PR.

tconbeer commented 1 month ago

Yeah, I have this same note in the sqlfmt docs, should def include for harlequin.

mahiki commented 1 month ago

Ah. Thanks for the amazing product!

Although, I usually scan the docs for the code block sections, it may be more visible with an explicit


pipx install harlequin[trino,s3]

# or, depending on OS and shell:
pipx install 'harlequin[trino,s3]'

tconbeer / harlequin-web

Docs: install instructions - add tip to quote package name w/ extras #87