Skip to content

README.md

Latest commit

 

History

History
153 lines (104 loc) · 4.66 KB

README.md

File metadata and controls

153 lines (104 loc) · 4.66 KB

github-ssh-key v1.0.0

GitHub ssh key manager. Console utility for creating, getting, testing, using public ssh keys for GitHub.

PyPI Downloads GitHub top language PyPI - Downloads GitHub release (latest by date) GitHub PyPI PyPI - Format GitHub Repo stars GitHub watchers GitHub forks

Supported:

  • Linux: All.
  • Termux (Android).

Images:

logo

Description:

github-ssh-key - GitHub ssh key manager. Console utility for creating, getting, testing, using public ssh keys for GitHub.

Possibilities:

  • Convenient interactive menu.
  • Generating ssh keys for GitHub.
  • Output ssh key to the console.
  • Adding ssh key to GitHub.
  • Checking the ssh key, testing the connection.
  • Interactive menu for working with the utility.
  • Interactive menu for help.
  • Launch the default browser with a page for adding ssh key on GitHub.
  • Cloning private repositories via ssh.
  • Running individual commands.

⚠️ Disclaimer

By using this software, you agree to the full disclaimer terms.

Summary: Software provided "AS IS" without warranty. You assume all risks.

Full legal disclaimer: See DISCLAIMER.md

Help:

Install and use:

Install:

pip install github-ssh-key

github-ssh-key

Use:

To access GitHub over ssh, you should run some sequence of actions.

  • Install openssh;
  • Generate new ssh keys;
  • Copy the public key;
  • Add your public key to GitHub;
  • Check the connection;

This utility provides you with these capabilities.

Adding a key to your GitHub account involves several steps:

  1. Generating new ssh key.
    • Install openssh, or make sure you have it installed with the ssh command.
    • During the generation process, enter your email that you use when working with GitHub.
    • Do not change the default file name.
    • Don't set a passphrase if you don't want to enter it every time.
  2. Copying ssh key.
    • Highlight and completely copy your ssh key.
  3. Adding ssh key to your GitHub account.
    • Highlight and completely copy your ssh key.
    • Add your ssh key to your GitHub account.
  4. Testing the ssh key (Testing the connection).
    • For a successful connection, you had to follow these steps:
      • Generate ssh key.
      • Highlight and completely copy your ssh key.
      • Add ssh key to your GitHub account.
      • If you did everything correctly, you will see a personalized greeting.

Also, directly from the interactive menu, you can clone your private repository using ssh.

To get help with commands, use:

github-ssh-key [command] -h

github-ssh-key new -h github-ssh-key show -h github-ssh-key add -h github-ssh-key test -h github-ssh-key clone -h github-ssh-key help -h

Commands:

github-ssh-key [command] [args]

  • run github-ssh-key run
  • new github-ssh-key new -e [your email]
  • show github-ssh-key show
  • add github-ssh-key add
  • test github-ssh-key test
  • clone github-ssh-key clone -l [GitHub login] -n [repo name]

Variant 1:

  • Go to the project folder
  • python setup.py install
  • github-ssh-key

Variant 2:

  • Install python
  • Go to the project folder
  • pip install -r requirements.txt
  • python github-ssh-key.py

License

BSD 3-Clause License

Copyright (©) 2026, Alexander Suvorov