Update auto-launching ssh-agent for Windows

[profojak]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases

What part(s) of the article would you like to see updated?

The Auto-launching ssh-agent on Git for Windows section of the article provides a bash script to automatically run ssh-agent when opening bash or Git shell, but these instructions do not work for Windows-native PowerShell.

Microsoft's documentation has 2 relevant articles that could be linked or quoted in the GitHub's documentation article.

Get started with OpenSSH for Windows article provides instructions on how to install both OpenSSH Client (providing ssh-agent command) and OpenSSH Server (providing ssh-keygen command) using a GUI and how to automatically start the OpenSSH Server service. Key-based authentication in OpenSSH for Windows article provides instructions on how to launch both Client and Server services from the PowerShell:

# Set the sshd service to be started automatically
Get-Service -Name sshd | Set-Service -StartupType Automatic

# Now start the sshd service
Start-Service sshd

ssh-keygen -t ed25519

# By default the ssh-agent service is disabled. Configure it to start automatically.
# Make sure you're running as an Administrator.
Get-Service ssh-agent | Set-Service -StartupType Automatic

# Start the service
Start-Service ssh-agent

# This should return a status of Running
Get-Service ssh-agent

# Now load your key files into ssh-agent
ssh-add $env:USERPROFILE\.ssh\id_ed25519

I believe this information should be included in the GitHub's documentation article.

Additional information

No response

[nguyenalex836]

@profojak Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

[guntrip]

Hi @profojak, thanks for opening this! There's so many ways to configure Git and SSH on Windows, our docs favour Git for Windows and step into Powershell when necessary to configure something. I think we risk making things confusing by adding too many different options but, on this particular page, I don't think that's the case and a new section for Powershell users would be beneficial.

We're currently working on a lot of changes to the SSH docs, so I'm going to transfer this issue internally so that the team can work on it.

Thank you so much for suggesting this, I think this will help a lot of folks! ✨