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`,
   9 etc).
  10
  11 ## Cheat Sheet
  12
  13 > Mutagen is a new kind of remote development tool that enables your existing
  14 > local tools to work with code in remote environments like cloud servers and
  15 > containers. It does this by providing high-performance real-time file
  16 > synchronization and flexible network forwarding.
  17
  18 ### Creating sessions
  19
  20 Create a synchronization session named "web-app-code" between the local path
  21 ~/project and an SSH-accessible endpoint.
  22
  23 ```bash
  24 mutagen sync create --name=web-app-code ~/project user@example.org:~/project
  25 ```
  26
  27 OR Create a forwarding session named "web-app" between port 8080 on localhost
  28 and port 1313 inside a Docker container.
  29
  30 ```bash
  31 mutagen forward create --name=web-app tcp:localhost:8080 docker://devcontainer:tcp:localhost:1313
  32 ```
  33
  34 ### Listing sessions
  35
  36 ```bash
  37 mutagen sync list
  38 ```
  39
  40 OR
  41
  42 ```bash
  43 mutagen forward list
  44 ```
  45
  46 ### Monitoring a session
  47
  48 ```bash
  49 mutagen sync monitor web-app-code
  50 ```
  51
  52 OR
  53
  54 ```bash
  55 mutagen forward monitor web-app
  56 ```
  57
  58 ### Pausing/resuming sessions
  59
  60 ```bash
  61 mutagen sync pause web-app-code
  62 ```
  63
  64 OR
  65
  66 ```bash
  67 mutagen forward pause web-app
  68 ```
  69
  70 To resume replace `pause` with `resume` in the above commands
  71
  72 ### Resetting session
  73
  74 ```bash
  75 mutagen sync reset web-app-code
  76 ```
  77
  78 ### Terminating session
  79
  80 ```bash
  81 mutagen sync terminate web-app-code
  82 ```
  83
  84 OR
  85
  86 ```bash
  87 mutagen forward terminate web-app
  88 ```
  89
  90 For general help
  91
  92 ```bash
  93 mutagen --help
  94 ```
  95
  96 For specific command help
  97
  98 ```bash
  99 mutagen <command> --help
 100 ```