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 <command> --help
```