yshayy / compose-generator Goto Github PK

Easy to use cli tool to generate Docker Compose configurations blazingly fast.

Please visit the documentation on compose-generator.com.

If Compose Generator helps you, please consider a GitHub star! ⭐

To install Compose Generator on your system, please visit the installation section in the documentation. Compose Generator is available for the latest versions of Alpine, CentOS, Debian, Fedora, Raspbian, Ubuntu and Windows. If you want to install Compose Generator manually by downloading a package file, please take a look at the table below.

After installing, you can use Compose Generator in the terminal like this:

$ compose-generator [<command>]

For Linux:

$ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/cg/out chillibits/compose-generator [<command>]

For Windows:

$ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v ${pwd}:/cg/out chillibits/compose-generator [<command>]

Note: This command does not work with Windows CMD command line. Please use Windows Terminal or PowerShell instead.

There are downloadable packages available for all supported platforms:

If you miss a predefined template and you want to create one for the public, please read the instructions to create a template. Fork the repository, create the template and open a pr against the release/v1.10.x branch. The community is thankful for every predefined template!

If you want to contribute to this project, please ensure you comply with the contribution guidelines.

© Marc Auberer 2021-2022