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.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssh_cli-2.3.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file ssh_cli-2.3.0.tar.gz.

File metadata

  • Download URL: ssh_cli-2.3.0.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

Hashes for ssh_cli-2.3.0.tar.gz
Algorithm Hash digest
SHA256 7a2b82cfd66a2cb5c6941caf0b2721a65a23677fe5d4f3d08ae7eab487fd75a1
MD5 016317056ddff23565319dd796f6330f
BLAKE2b-256 5d3b277495a2a1b0d42f45cd3dfab44c4cdbc1760e9ac0862c314436cd3a1579

See more details on using hashes here.

File details

Details for the file ssh_cli-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: ssh_cli-2.3.0-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

Hashes for ssh_cli-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61bbd0adfb71a2a34fce90b805a49353b0e822073357b0a28577a934395c65ac
MD5 efa6d51c10867c4abc4f7f66b4ad9c19
BLAKE2b-256 d88c9360e943f966e8b6872e6048303e5ff8e92599be1263757817f21a26ce53

See more details on using hashes here.

Supported by

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