Metadata-Version: 2.1
Name: ssh-aws
Version: 2.3.6
Summary: SSH into your EC2 instances.
Home-page: https://gitlab.com/franciscogd/awssh
Author: Francisco Duran
Author-email: franciscogd@gatech.edu
License: UNKNOWN
Download-URL: https://gitlab.com/franciscogd/awssh/archive/2.3.6.tar.gz
Description: awssh
        ----------------
        
        SSH boto3 utility for AWS
        
        Installation
        ----------------
        First, install the aws-cli and boto3 libraries: 
        ```bash
        $ pip3 install awscli --upgrade --user
        $ pip install boto3
        ```
        Next, set up credentials and default region:
        ```bash
        $ aws configure
        ```
        Finally, install the `awssh` utility:
        ```bash
        $ pip install ssh-aws # or pip install --user ssh-aws
        ```
        
        **Note**: The `awssh` utility is installed in `$HOME/Library/Python/2.7/bin` which may not be on PATH.
        Consider adding this directory to PATH.
        
        Version update
        ----------------
        ```
        $ echo y | pip uninstall ssh-aws
        $ pip install --no-cache --user ssh-aws
        $ awssh --version
        ```
        
        
        Requirements
        ----------------
        
        - Python 2.7
        - boto3
        - aws-cli
        
        Features
        ----------------
        
        The `awssh` utility gives you a list of aws instances and preconfigures `ssh` with the proper key and user.
        You can filter by instance name. If it matches only one instance you will be logged into it.
        This utility also allows local and remote port forwarding for SSH tunneling (e.g. `ssh -L 9000:imgur.com:80 user@<ip_address>`).
        By default, ssh command is executed with the -A option, which enables forwarding the authentication agent connection. 
        This is particularly useful when using a single access point such as a jump server. 
        In addition, if an instance without an external IP is selected, the utility attempts to find a bastion server and ssh with the -t option (e.g. `ssh -A ubuntu@<bastion> -t ssh <ip_address>`).
        
        Usage
        -----
        
        ```
        usage: awsh [-h] [--region REGION] [--profile PROFILE] [--users USERS [USERS ...]]
                           [-i KEY_PATH] [-c COMMAND] [-r REMOTE_HOST]
                           [-p REMOTE_PORT] [-l LOCAL_PORT] [--keys KEYS]
                           [--timeout TIMEOUT] [--console-output] [--version]
                           [instance name key word]
        
        SSH into AWS instances. The default user list assumes that your user is centos, ubuntu, or ec2-user.
        
        positional arguments:
          filter                Optional instance name or key word as filter. If only one instance is found,
                                it will connect to it directly.
        
        optional arguments:
          -h, --help            Show usage message and exit.
          --users USERS [USERS ...]
                                Users to try (centos, ubuntu, and ec2-user are defaults).
          --region REGION       AWS region (User default if non is provided).
          -i KEY_PATH, --key-path KEY_PATH
                                Specific key path, overrides, --keys
          -c COMMAND, --command COMMAND
                                Translates to ssh -C
          -r REMOTE_HOST, --remote-host REMOTE_HOST
                                Open a tunnel.
                                Equivalent to ssh -L <local-port>:<remote-host>:<remote-port> <selected-aws-host>
          -p REMOTE_PORT, --remote-port REMOTE_PORT
                                Port to use on the remote host (default is 5432).
          -l LOCAL_PORT, --local-port LOCAL_PORT
                                Port to use on the local host. Get overwritten by
                                remote port if not defined.
          --keys KEYS           Directory of the private keys (~/.ssh by default).
          --timeout TIMEOUT     SSH connection timeout.
          --console-output      Display the instance console out before logging in.
          --profile             Use a specific profile from your credentials file.
          --version             Returns awssh's version.
        
          Examples:
            "awssh --region us-east-2"
            "awssh --users user1 user2 --region us-east-2 --keys '~/.ssh' instance-name"
            "awssh instance-name --users user1 user2".
        
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
