Repository navigation
Clarify install steps for various OS #287
Description
macOS:
For the installation, specifically macOS, we do not mention Homebrew as a prerequisite for the installation. Xcode Install Tools are also required, but Homebrew takes care of that, but perhaps because I have Xcode already?
Running brew install github/gh/gh without Homebrew results in command not found error.
Also, there is no mention of the SSH or HTTPS authentication, nor the subsequent browser authentication.
I am not sure what else I am missing?
Linux:
If authenticating with a personal access token (PAT), you need to add this to your gh config.
~/.config/gh/config.yml
yaml
github.com:
- user: $GITHUB_USERNAME
oauth_token: $PERSONAL_ACCESS_TOKEN
Windows:
Scoop...
Uninstalling
Directions to do an uninstall would be great too
Minimum req's
Each OS should have the following:
- dependencies, prerequisites for installing
- instructions for installing
- instructions for authenticating
- instructions for upgrading
- instructions for uninstalling
Reacted by Michael McMahon and Jan Pokorný
Activity
[-]Clarify install steps for Mac[/-][+]Clarify install steps for various OS[/+]tierninho commentedon Feb 4, 2020
Scoop ref: #298
tierninho commentedon Feb 4, 2020
Updated Windows with the Scoop install method successfully, however I ran into some issues worth noting in our install guide or a "common problems" doc.
The install command
scoop install curlon Scoop did not work, which led me to a this error and workaround:Error:
Workaround in Powershell (as admin):
set-executionpolicy remotesigned -s currentuseriex (new-object net.webclient).downloadstring('https://get.scoop.sh')Scoop successfully installed 🎉
I then ran the two commands from our install guide:
scoop bucket add github-gh https://github.com/cli/scoop-gh.gitscoop install ghand everything is working with
ghon Windows now.waldyrious commentedon Feb 13, 2020
It's worth mentioning that Homebrew also works for Linux systems. The formula can be found in the Homebrew/linuxbrew-core repo.
madhavtummala commentedon Feb 15, 2020
brew install githubdoesn't work.brew install ghworksmwichmann commentedon Feb 17, 2020
To the Linux instructions above, note that in #479 @mislav writes:
so those don't seem to be the right instructions.
mislav commentedon Feb 19, 2020
Updating the package on Fedora might require uninstall+reinstall: #498
mislav commentedon Feb 27, 2020
@tierninho Are the installation instructions for various OS still unclear?
waldyrious commentedon Feb 27, 2020
@mislav I think it would be worth having the Homebrew installation instructions in a separate section rather than under macOS exclusively, since Homebrew now has support for Linux as well.
tierninho commentedon Feb 27, 2020
@mislav I would say yes until these are outlined:
F4NT0 commentedon Apr 24, 2020
So, use linux update doesn't help then, i will need to reinstall all again
l3ender commentedon Sep 18, 2020
It would also be nice if zip install options were mentioned for Windows. #1740 (comment).
mislav commentedon Oct 1, 2020
Closing since our installation/upgrading options are well documented now for various OS: https://github.com/cli/cli#installation
waldyrious commentedon Oct 2, 2020
@mislav was it intentional to leave the Homebrew option out of the Linux installation docs?
mislav commentedon Oct 7, 2020
@waldyrious No! You are welcome to put it back 🙇
waldyrious commentedon Oct 11, 2020
@mislav thanks for the confirmation — I've just submitted #2156 to address that.
feat(a2a): tools as skills (cli#287)