Skip to main content

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

Project description

github-ssh-key v0.4.1

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


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


Author and developer: A.A. Suvorov


Supported:

  • Linux: All.
  • Termux (Android).

Images:

logo


What's new?

github-ssh-key v0.3.0

  • Improved work with help, added the ability to run commands directly from help.
  • Improved interface.

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.

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

Disclaimer of liability:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright:

--------------------------------------------------------
Licensed under the terms of the BSD 3-Clause License
(see LICENSE for details).
Copyright © 2018-2024, A.A. Suvorov
All rights reserved.
--------------------------------------------------------

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_ssh_key-0.4.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

github_ssh_key-0.4.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file github_ssh_key-0.4.1.tar.gz.

File metadata

  • Download URL: github_ssh_key-0.4.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for github_ssh_key-0.4.1.tar.gz
Algorithm Hash digest
SHA256 43aac8889fac838e2c0aee0fa82df6afb69bc7999ecfcf7207d142ce524a9109
MD5 9200ce0fe7554e974bbad62be8abac86
BLAKE2b-256 dbf1c74e240d5f6e26e0fcde54caa75cfa10ebba39519bcba6feefeb6c2fe148

See more details on using hashes here.

File details

Details for the file github_ssh_key-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for github_ssh_key-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f077ea17855ee19e2028dcb5050c1aec7e50bdbcaf1a93371becab392594fcc
MD5 797355006e6392235a31249273685a97
BLAKE2b-256 998457e9588dba726439cceb6bc49df8ea81144908950a8956eb19d0b277e602

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page