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.