@compose-generator/cli

Easy to use cli to generate Docker Compose YAML configuration files.

Usage no npm install needed!

<script type="module">
  import composeGeneratorCli from 'https://cdn.skypack.dev/@compose-generator/cli';
</script>

README

Compose Generator Logo

Compose Generator

Easy to use cli to generate Docker Compose YAML configuration files.


Documentation

Please visit the documentation on compose-generator.com.

Usage

You can use the Compose Generator CLI by directly installing it on your Docker host system, install it via npm or by generating your compose file with the Compose Generator Docker container on the fly.

Install Compose Generator CLI

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, Windows. If you want to install Compose Generator manually, please look at the table below.

QuickStart with Docker

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

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

Supported host systems & file downloads

There are also downloadable packages available for all supported platforms:

Platform x86_64 / amd64 i386 armv5 armv6 armv7 arm64
Darwin / MacOS (tar.gz) download - - - - -
FreeBSD (tag.gz) download download download download download download
Alpine (apk) download download download download download download
CentOS (rpm) download download download download download download
Debian (deb) download download download download download download
Fedora (rpm) download download download download download download
Raspbian (deb) download download - download download download
Ubuntu (deb) download download download download download download
Windows Installer (exe) download download - - - -
Windows Portable (zip) download download - - - -

Contribute by providing predefined templates

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

Contribute otherwise to the project

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

© Marc Auberer 2021