X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;ds=inline;f=mutagen%2FREADME.md;h=39b96c4c0ece293397565f321ad02fe1748576f7;hb=29d0b6075ede95931cae301d7050d60309e08ff7;hp=e887eec7341f9eba7dc3d6cf506c5ad18b4451f9;hpb=237b7dc9fc77fe66ae4089908af04a433b271cca;p=webi-installers%2F.git diff --git a/mutagen/README.md b/mutagen/README.md index e887eec..39b96c4 100644 --- a/mutagen/README.md +++ b/mutagen/README.md @@ -5,71 +5,96 @@ tagline: | mutagen: Remote development tool --- -To update or switch versions, run `webi mutagen@stable` (or `@v2`, `@beta`, etc). +To update or switch versions, run `webi mutagen@stable` (or `@v2`, `@beta`, +etc). ## Cheat Sheet -> Mutagen is a new kind of remote development tool that enables your existing local tools to work with code in remote environments like cloud servers and containers. It does this by providing high-performance real-time file synchronization and flexible network forwarding. +> Mutagen is a new kind of remote development tool that enables your existing +> local tools to work with code in remote environments like cloud servers and +> containers. It does this by providing high-performance real-time file +> synchronization and flexible network forwarding. ### Creating sessions -Create a synchronization session named "web-app-code" between the local path ~/project and an SSH-accessible endpoint. + +Create a synchronization session named "web-app-code" between the local path +~/project and an SSH-accessible endpoint. + ```bash mutagen sync create --name=web-app-code ~/project user@example.org:~/project ``` -OR -Create a forwarding session named "web-app" between port 8080 on localhost and port 1313 inside a Docker container. + +OR Create a forwarding session named "web-app" between port 8080 on localhost +and port 1313 inside a Docker container. + ```bash mutagen forward create --name=web-app tcp:localhost:8080 docker://devcontainer:tcp:localhost:1313 ``` ### Listing sessions + ```bash mutagen sync list ``` + OR + ```bash mutagen forward list ``` ### Monitoring a session + ```bash mutagen sync monitor web-app-code ``` + OR + ```bash mutagen forward monitor web-app ``` ### Pausing/resuming sessions + ```bash mutagen sync pause web-app-code ``` + OR + ```bash mutagen forward pause web-app ``` + To resume replace `pause` with `resume` in the above commands ### Resetting session + ```bash mutagen sync reset web-app-code ``` ### Terminating session + ```bash mutagen sync terminate web-app-code ``` + OR + ```bash mutagen forward terminate web-app ``` For general help + ```bash mutagen --help ``` For specific command help -```bash + +```bash mutagen --help ```