README
¶
Mutagen Compose
Mutagen Compose is a (minimally) modified version of Docker Compose that offers automated integration with Mutagen. This allows you to synchronize files and forward network traffic between your local system and your Compose services. While this is primarily designed for using Compose to develop on a remote and/or cloud-based Docker engine, it can also be used with Docker Desktop to provide a high-performance alternative to the virtual filesystems used in Docker Desktop bind mounts.
Usage
Check out the Mutagen Compose documentation for usage information.
System requirements
Mutagen Compose is currently supported on macOS, Linux, and Windows and is available for a variety of architectures.
To use Mutagen Compose, you will need the Docker CLI (i.e the docker command)
installed and available in your path. You can get this via a number of
official Docker channels, via your
system's package manager, or via a third-party package manager such as
Homebrew.
You will also need a matching version of Mutagen installed and available in your path.
Installation
The best way to install Mutagen Compose is via Homebrew using:
brew install mutagen-io/mutagen/mutagen-compose
Alternatively, you can download the official release binary and put it in your path.
Community
The Mutagen Community Slack Workspace is the place to go for discussion, questions, and ideas.
For updates about the project and its releases, you can follow Mutagen on Twitter.
Status
Mutagen Compose is built and tested on Windows, macOS, and Linux.
| Tests | Report card | License |
|---|---|---|
 |
 |
Contributing
If you'd like to contribute to Mutagen Compose, please see the contribution documentation.
Security
Mutagen and its related projects take security very seriously. If you believe you have found a security issue with Mutagen Compose, please practice responsible disclosure practices and send an email directly to security@mutagen.io instead of opening a GitHub issue. For more information, please see the security documentation.
Building
Please see the build instructions.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
mutagen-compose
Docker Compose plugin-based invocation.
|
Docker Compose plugin-based invocation. |
|
pkg
|
|
|
compose
Package compose provides infrastructure for interfacing wth Compose.
|
Package compose provides infrastructure for interfacing wth Compose. |
|
docker
Package docker provides infrastructure for interfacing wth Docker.
|
Package docker provides infrastructure for interfacing wth Docker. |
|
legal
Package legal embeds legal information for Mutagen Compose.
|
Package legal embeds legal information for Mutagen Compose. |
|
mutagen
Package mutagen provides infrastructure for interfacing wth Mutagen.
|
Package mutagen provides infrastructure for interfacing wth Mutagen. |
|
version
Package version provides version information.
|
Package version provides version information. |