-
Notifications
You must be signed in to change notification settings - Fork 5.6k
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
Document where authentication credentials are stored #1773
Comments
@raiskila Have you tried
The authentication credentials are stored in Good points about documentation; thank you! |
Thanks for pointing that out, I was on 0.9.0 due to outdated Homebrew formulas and Yeah, this was mostly about the documentation, but I'm glad the information is also available there! |
@mislav Hi there, I was taking a look at this issue but I couldn't find where the documentation should be. I am guessing https://cli.github.com/manual/gh_auth_status here but even if that's the right place I don't see where or how the project is generating the documentation. If you could point me in the right direction I can help out with the change. Thanks 🙇 |
@cored Our documentation pages are autogenerated by spf13/cobra during our release workflow. As for where we actually want this documentation to be placed I think we should wait for @mislav to chime in on that. |
Where would you like that directory to be? |
Please document clearly where sensitive information is stored, and whether or not it is stored in plain text form. For example, it appears |
For this bit specifically, see #449 |
Fwiw, I'd expect to be able to find the information by looking here: https://cli.github.com/manual/gh_config Remember, users don't know a system when they're looking for answers. The actual answer can be stored in |
Related question: It is unclear to me if trying to configure SSH auth is going to wipe-out my existing ssh authentication for Git. I already have an ssh key generated, and uploaded to Github, but the Does this warrant a new issue specifically to allow using existing ssh configurations? |
@kyle-rader |
@vilmibm thanks for clarifying Nate, this makes sense. I take it github just doesn't support ssh auth for their web api? Only the git endpoints? |
@kyle-rader correct. |
@jsoref, I think it would also make sense to put the information in
I think it should explain what it is changing in |
I wonder if there is an way to ask gh to report credentials (token) for a specific server. I am writing a python tool that uses github api to perform some tasks and re-using authentication from gh makes it easier for users instead of adding another place to store credentials. |
I think So, I guess mentioning the possibility of storing credentials inside the config dir on the document above would be helpful. |
Describe the feature or problem you’d like to solve
I can't find any information on the website or in the CLI help command about where authentication information is stored.
Proposed solution
Document where GH CLI stores authentication credentials. Also explain the relationship of this with existing GitHub credentials you may have on your system, like an SSH key or git https credentials in the keychain.
This helps the user understand the security and practical implications of logging in to the CLI.
The text was updated successfully, but these errors were encountered: