Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify install steps for various OS #287

Open
tierninho opened this issue Jan 31, 2020 · 6 comments
Open

Clarify install steps for various OS #287

tierninho opened this issue Jan 31, 2020 · 6 comments
Labels

Comments

@tierninho
Copy link
Contributor

@tierninho tierninho commented Jan 31, 2020

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
@tierninho tierninho added mac and removed mac labels Jan 31, 2020
@tierninho tierninho changed the title Clarify install steps for Mac Clarify install steps for various OS Jan 31, 2020
@tierninho

This comment has been minimized.

Copy link
Contributor Author

@tierninho tierninho commented Feb 4, 2020

Scoop ref: #298

@tierninho

This comment has been minimized.

Copy link
Contributor Author

@tierninho tierninho commented 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 curl on Scoop did not work, which led me to a this error and workaround:

Error:

The term `scoop' is not recognized as the name of a cmdlet, function, script file, or operable
program. Check the spelling of the name, or if a path was included, verify
that the path is correct and try again.

Workaround in Powershell (as admin):

  • Enabled powershell for current user : set-executionpolicy remotesigned -s currentuser
  • Installed scoop : iex (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.git
scoop install gh

and everything is working with gh on Windows now.

@tierninho tierninho added the docs label Feb 6, 2020
@waldyrious

This comment has been minimized.

Copy link

@waldyrious waldyrious commented 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.

@MadhavChoudhary

This comment has been minimized.

Copy link

@MadhavChoudhary MadhavChoudhary commented Feb 15, 2020

brew install github doesn't work.
brew install gh works

@mwichmann

This comment has been minimized.

Copy link

@mwichmann mwichmann commented Feb 17, 2020

To the Linux instructions above, note that in #479 @mislav writes:

Note that we don't really support Personal Access Tokens,

so those don't seem to be the right instructions.

@mislav

This comment has been minimized.

Copy link
Collaborator

@mislav mislav commented Feb 19, 2020

Updating the package on Fedora might require uninstall+reinstall: #498

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.