An open API service indexing awesome lists of open source software.

https://github.com/smartlegionlab/github-ssh-key

Simplifies the cloning of private GitHub repositories, for example on Termux or on a server.
https://github.com/smartlegionlab/github-ssh-key

cli-app git-clone git-cloner github-ssh github-ssh-key pypi python-cli-app python3 smartlegionlab termux termux-tool termux-tools

Last synced: about 1 month ago
JSON representation

Simplifies the cloning of private GitHub repositories, for example on Termux or on a server.

Awesome Lists containing this project

README

          

# github-ssh-key v1.0.0

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

---

[![PyPI Downloads](https://static.pepy.tech/badge/github-ssh-key)](https://pepy.tech/projects/github-ssh-key)
![GitHub top language](https://img.shields.io/github/languages/top/smartlegionlab/github-ssh-key)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/github-ssh-key?label=pypi%20downloads)](https://pypi.org/project/github-ssh-key/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/smartlegionlab/github-ssh-key)](https://github.com/smartlegionlab/github-ssh-key/)
[![GitHub](https://img.shields.io/github/license/smartlegionlab/github-ssh-key)](https://github.com/smartlegionlab/github-ssh-key/blob/master/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/github-ssh-key)](https://pypi.org/project/github-ssh-key)
[![PyPI - Format](https://img.shields.io/pypi/format/github-ssh-key)](https://pypi.org/project/github-ssh-key)
[![GitHub Repo stars](https://img.shields.io/github/stars/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)
[![GitHub watchers](https://img.shields.io/github/watchers/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)
[![GitHub forks](https://img.shields.io/github/forks/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)

---

## Supported:

- Linux: All.
- Termux (Android).

---

## Images:

![logo](https://github.com/smartlegionlab/github-ssh-key/raw/master/data/images/github-ssh-key.png)

---

## 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](https://github.com/smartlegionlab/github-ssh-key/blob/master/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](https://python.org)
- Go to the project folder
- `pip install -r requirements.txt`
- `python github-ssh-key.py`

---

## License

**[BSD 3-Clause License](https://github.com/smartlegionlab/github-ssh-key/blob/master/LICENSE)**

Copyright (©) 2026, [Alexander Suvorov](https://github.com/smartlegionlab)

---