cli to manage the ssh config file
Project description
SSH-CLI
This CLI tool allows you to create and manage your SSH config file, streamlining the process of handling SSH connections.
Installation
To install SSH-Tool, simply run the following command:
pip install ssh-cli
Usage
After installation, you can start using SSH-Tool by executing:
ssh-cli
Features
SSH-Tool comes with a variety of features to manage your SSH configurations efficiently:
- Add a New Host: Easily add new hosts to your SSH config, with or without specifying a key.
- Remove a Host: Remove hosts from your SSH config.
- List All Hosts: Get a comprehensive list of all the hosts in your SSH config.
- Connect to a Host: Initiate a connection to a specified host directly.
- Edit SSH Config File: Open and edit your SSH config file with your preferred editor.
- Cleanup SSH Keys: Remove unused SSH keys from your directory.
Configuration
This tool can be configured with Environment Variables:
Variable | Description | Default |
---|---|---|
SSH_CLI_CONFIG_FILE |
Path to the SSH config file (will be created if nonexitent) | ~/.ssh/config |
SSH_CLI_KEY_DIR |
Path to the directory where the keys are stored (will be created if nonexitent) | ~/.ssh/keys nano` |
SSH_CLI_KEY_TYPE |
Type of generated ssh keys | ed25519 |
SSH_CLI_DEFAULT_USER |
The default user for creating new ssh hosts | $USER |
SSH_CLI_DEFAULT_PORT |
The default port for creating new ssh hosts | 22 |
SSH_CLI_EDITOR |
The editor to use for editing the ssh config file | $EDITOR else nano |
Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ssh_cli-2.3.5.tar.gz
.
File metadata
- Download URL: ssh_cli-2.3.5.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.5.0-1016-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d25333934d8990f13b12fa3e23b235208f8979a112965374e59b528d672ae283 |
|
MD5 | 576d121d4c90869897055c572540e17e |
|
BLAKE2b-256 | c22af2efd78aa0917b236580993ee2230d2980790d6b4bf70fa92c90e0639167 |
File details
Details for the file ssh_cli-2.3.5-py3-none-any.whl
.
File metadata
- Download URL: ssh_cli-2.3.5-py3-none-any.whl
- Upload date:
- Size: 12.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.5.0-1016-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a89dcd063cd23f33fd263a1a818a95950b72ef846fc597dc40cfeefa04fef13 |
|
MD5 | 863ffceaeccc449a2a22fbdd21c6345b |
|
BLAKE2b-256 | 44f38e464b95d5d685dc26f94bae1f25ceaecbe72e3f83b145d4cc09402940a2 |