Metadata-Version: 2.1
Name: connectionmaster
Version: 0.0.8
Summary: A python utility for remote server management
Home-page: https://github.com/nathansmerrill/connectionmaster
Author: Nathan Merrill
Author-email: mathiscool3000@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: blinkparse

# Connection Master
A command line remote server connection and management tool

# Installation
`$ pip install connectionmaster`  
MacOS  
`$ echo alias cm='python3 -m connectionmaster' > ~/.bash_profile`  
Linux  
`$ echo alias cm='python3 -m connectionmaster' > ~/.bashrc`

The config file is `~/.cmrc.yaml`

# Usage
There are long and one letter forms for every command
```
$ cm connect myServer
$ cm c myServer
$ cm execute mySecondServer "echo hi > test.txt"
$ cm x mySecondServer "echo hi > test.txt"
$ cm scp myThirdServer localfile remotefile
$ cm scp myThirdServer localfile remotefile
$ cm ping myFourthServer
$ cm p myFourthServer
$ cm edit
$ cm e
```

# Config file
```yaml
myServer:
    ip: 'xxx.xxx.xxx.xxx'
    user: 'myUser'

# The jump option takes the server to jump ssh through
mySecondServer:
    ip: 'yyy.yyy.yyy.yyy'
    port: '2000'
    key: 'mySecondServerKey'
    jump: 'myServer'

# The ip isn't needed when you specify a full command but is needed to ping the server
myThirdServer:
    ip: 'zzz.zzz.zzz.zzz'
    command: 'vncviewer zzz.zzz.zzz.zzz:0'
    justRunCommand: True
```

# Config values
| Value | Meaning | Default |
| --- | --- | --- |
| `command` | The command to run | `ssh` |
| `user` | The user to log in as | The current user |
| `ip` | The IP to connect to | `localhost` |
| `port` | The port to connect to | `22` |
| `key` | The ssh key to use | No key |
| `jump` | A server to jump ssh through | Nothing |
| `justRunCommand` | Just runs `command` without adding ip, port, etc | `False` |

