diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f20bb9 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Moshy-rust: a simple Mosh wrapper with profile settings, but in Rust + +## Attributes + +

This is a rewrite of a project https://github.com/kiniou/moshy
+The original idea belongs to [kiniou](https://github.com/kiniou).

+ +## Introduction +

Moshy is a simple python Rust script which allow a user to connect to mosh server with
+different settings per hosts like port ranges or commands to run immediately once logged in.

+ +## Installation + +```bash +cargo install +``` + +## Configuration + +Moshy wraps mosh in order to use configuration profiles from the following path: + +``` +/etc/moshy.conf # System configuration +${HOME}/.moshy.conf # Per-user configuration +``` + +

You can select a profile by passing `hostname` argument and extra arguments
+which will be executed to the remote mosh session.

+ +The `hostname` parameter match configuration sections and can be formatted like the following: + +``` +hostname - connect to a remote hostname +user@hostname - connect a specific user to connect with +hostname:flavor +user@hostname:flavor - 'flavor' is an arbitrary name that can be + used to reference your commands. +``` + +

You can simply list configured profiles by using the list command and get more
+information on profile configured.

+