add readme

Signed-off-by: Dmytro Stanchiev <git@dmytros.dev>
This commit is contained in:
2025-10-31 11:52:34 -04:00
parent b52a48a0d8
commit 6b906ccea8

42
README.md Normal file
View File

@@ -0,0 +1,42 @@
# Moshy-rust: a simple Mosh wrapper with profile settings, but in Rust
## Attributes
<p>This is a rewrite of a project https://github.com/kiniou/moshy<br>
The original idea belongs to [kiniou](https://github.com/kiniou).</p>
## Introduction
<p>Moshy is a simple <s>python</s> Rust script which allow a user to connect to mosh server with<br>
different settings per hosts like port ranges or commands to run immediately once logged in.</p>
## 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
```
<p>You can select a profile by passing `hostname` argument and extra arguments<br>
which will be executed to the remote mosh session.</p>
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.
```
<p>You can simply list configured profiles by using the list command and get more<br>
information on profile configured.</p>