Metadata-Version: 1.1
Name: cloudssh
Version: 1.4
Summary: EC2 SSH connections helper
Home-page: https://github.com/gabfl/cloudssh
Author: gab
Author-email: gab@confiant.com
License: UNKNOWN
Description: cloudssh
        ========
        
        |Build Status| |codecov| |MIT licensed|
        
        EC2 SSH connections helper
        
        An SSH connection helper for AWS
        --------------------------------
        
        ``cloudssh`` allows you to quickly connect to EC2 instances using their
        names or instance IDs.
        
        It will call the AWS SDK to find the instance public IP address and open
        a SSH connection in a subprocess.
        
        Example:
        
        .. figure:: https://github.com/gabfl/cloudssh/blob/master/img/ec2.png?raw=true
           :alt: EC2
        
           EC2
        
        You can connect to this instance with:
        
        ::
        
           cssh dev
        
        You can also use the **auto-completion feature** by building a local
        index of your AWS instances then calling ``cloudssh`` without any
        argument.
        
        ::
        
           cssh --build_index
           # The instances index has been stored in ~/.cloudssh/.
        
           cssh
           # Start typing an instance name and press [TAB] to auto complete.
        
        Or search instances by name with:
        
        ::
        
           cssh --build_index
           # The instances index has been stored in ~/.cloudssh/.
        
           cssh --search http
           # Found "web-http-prod", connect? [Y/n]: 
        
        Or lookup an instance details:
        
        ::
        
           cssh web-http-prod --info
           # * Network
           # Public ID: 123.***.***.***
           # Private ID: 10.***.***.***
           #
           # * VPC/subnet
           # VPC ID: vpc-******
           # Subnet ID: subnet-******
           #
           # * Misc
           # Instance name: web-http-prod
           # Instance ID: i-******
           # Instance type: t2.xlarge
           # Launch date: 2019-10-12 15:44:36+00:00
           #
           # * Tags
           #   product = web_cluster
           #   environment = production
           #   Name = web-http-prod
        
        Example:
        
        .. figure:: https://github.com/gabfl/cloudssh/blob/master/img/autocomplete_demo.gif?raw=true
           :alt: EC2
        
           EC2
        
        Installation and usage
        ----------------------
        
        .. code:: bash
        
           pip3 install cloudssh
           aws configure # To configure your AWS credentials
        
           cssh myserver # Call the module followed by the name of one of your servers
        
        Advanced configuration
        ----------------------
        
        You can optionally create a file ``~/.cloudssh/cloudssh.cfg`` (see
        `example <cloudssh.cfg.sample>`__).
        
        .. |Build Status| image:: https://travis-ci.org/gabfl/cloudssh.svg?branch=master
           :target: https://travis-ci.org/gabfl/cloudssh
        .. |codecov| image:: https://codecov.io/gh/gabfl/cloudssh/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/gabfl/cloudssh
        .. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-green.svg
           :target: https://raw.githubusercontent.com/gabfl/cloudssh/master/LICENSE
        
Platform: UNKNOWN
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
