Skip to main content

cli to manage the ssh config file

Project description

SSH-CLI

PyPI GitHub Actions Workflow Status

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/keysnano`
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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

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

ssh_cli-2.3.5.tar.gz (8.8 kB view hashes)

Uploaded Source

Built Distribution

ssh_cli-2.3.5-py3-none-any.whl (12.7 kB view hashes)

Uploaded Python 3

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