mutagen/README.md

   1 ---
   2 title: mutagen
   3 homepage: https://github.com/mutagen-io/mutagen
   4 tagline: |
   5   mutagen: Remote development tool
   6 ---
   7
   8 To update or switch versions, run `webi mutagen@stable` (or `@v2`, `@beta`, etc).
   9
  10 ## Cheat Sheet
  11
  12 > 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.
  13
  14 ### Creating sessions
  15 Create a synchronization session named "web-app-code" between the local path ~/project and an SSH-accessible endpoint.
  16 ```bash
  17 mutagen sync create --name=web-app-code ~/project user@example.org:~/project
  18 ```
  19 OR
  20 Create a forwarding session named "web-app" between port 8080 on localhost and port 1313 inside a Docker container.
  21 ```bash
  22 mutagen forward create --name=web-app tcp:localhost:8080 docker://devcontainer:tcp:localhost:1313
  23 ```
  24
  25 ### Listing sessions
  26 ```bash
  27 mutagen sync list
  28 ```
  29 OR
  30 ```bash
  31 mutagen forward list
  32 ```
  33
  34 ### Monitoring a session
  35 ```bash
  36 mutagen sync monitor web-app-code
  37 ```
  38 OR
  39 ```bash
  40 mutagen forward monitor web-app
  41 ```
  42
  43 ### Pausing/resuming sessions
  44 ```bash
  45 mutagen sync pause web-app-code
  46 ```
  47 OR
  48 ```bash
  49 mutagen forward pause web-app
  50 ```
  51 To resume replace `pause` with `resume` in the above commands
  52
  53 ### Resetting session
  54 ```bash
  55 mutagen sync reset web-app-code
  56 ```
  57
  58 ### Terminating session
  59 ```bash
  60 mutagen sync terminate web-app-code
  61 ```
  62 OR
  63 ```bash
  64 mutagen forward terminate web-app
  65 ```
  66
  67 For general help
  68 ```bash
  69 mutagen --help
  70 ```
  71
  72 For specific command help
  73 ```bash
  74 mutagen <command> --help
  75 ```