MCPcopy Index your code
hub / github.com/compose-generator/compose-generator

github.com/compose-generator/compose-generator @1.9.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 1.9.0 ↗ · + Follow
499 symbols 1,520 edges 148 files 289 documented · 58%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Compose Generator Logo

Compose Generator

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

<a target="_blank" href="https://github.com/compose-generator/compose-generator/releases/latest"><img src="https://img.shields.io/github/v/release/compose-generator/compose-generator?include_prereleases"></a>
<a target="_blank" href="https://hub.docker.com/r/chillibits/compose-generator"><img src="https://img.shields.io/docker/pulls/chillibits/compose-generator"></a>
<a target="_blank" href="https://github.com/compose-generator/compose-generator/actions/workflows/test.yml"><img src="https://github.com/compose-generator/compose-generator/workflows/Go%20CI/badge.svg"></a>
<a target="_blank" href="https://github.com/compose-generator/compose-generator/actions/workflows/codeql-analysis.yml"><img src="https://github.com/compose-generator/compose-generator/actions/workflows/codeql-analysis.yml/badge.svg"></a>
<a target="_blank" href="https://goreportcard.com/report/github.com/compose-generator/compose-generator"><img src="https://goreportcard.com/badge/github.com/compose-generator/compose-generator"></a>
<a href="https://codecov.io/gh/compose-generator/compose-generator"><img src="https://codecov.io/gh/compose-generator/compose-generator/branch/main/graph/badge.svg?token=r9pWf0GCXg"/></a>
<a target="_blank" href="https://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
<a target="_blank" href="https://github.com/compose-generator/compose-generator/raw/1.9.0/LICENSE"><img src="https://img.shields.io/github/license/compose-generator/compose-generator"></a>

Please visit the documentation on compose-generator.com.

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

Install Compose Generator

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>]

QuickStart with Docker

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.

Supported host systems & file downloads

There are downloadable packages available for all supported platforms:

Platform amd64 i386 armv5 armv6 armv7 arm64
Darwin / MacOS (tar.gz) 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 (msi) 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 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!

Contribute otherwise to the project

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

© Marc Auberer 2021-2022

Extension points exported contracts — how you extend this code

DeleteOption (FuncType)
DeleteOption represents a callback function option for the DeleteProject function
src/project/delete_options.go
Suggest (FuncType)
Suggest is a function for settings suggestions to a question for autocompletion
src/util/questions.go
SaveOption (FuncType)
SaveOption represents a callback function option for the SaveProject function
src/project/save_options.go
LoadOption (FuncType)
LoadOption represents a callback function option for the LoadProject function
src/project/load_options.go

Core symbols most depended-on inside this repo

handleInterrupt
called by 14
src/util/questions.go
delete
called by 12
src/cmd/template-delete.go
ReplaceVarsInString
called by 10
src/util/common.go
InstallDocker
called by 8
src/pass/install/install_docker_linux.go
GetAll
called by 8
src/model/predefined-template.go
GetPredefinedServicesPath
called by 8
src/util/env.go
replaceGroupDependency
called by 7
src/pass/generate/gen_dependency_groups.go
getLogfilesPath
called by 7
src/util/env.go

Shape

Function 460
Struct 17
Method 13
FuncType 4
Route 3
TypeAlias 2

Languages

Go97%
Python3%
Rust1%

Modules by API surface

src/util/env_test.go33 symbols
src/util/questions.go16 symbols
src/util/conditions_test.go16 symbols
src/model/predefined-template.go15 symbols
src/util/env.go14 symbols
src/pass/generate/gen_load_config_test.go12 symbols
src/project/delete_test.go11 symbols
src/util/cli.go10 symbols
src/pass/add/add_volumes_test.go10 symbols
src/model/cg-project.go10 symbols
src/model/cg-project_test.go9 symbols
src/util/text.go8 symbols

Datastores touched

(mysql)Database · 1 repos
(mongodb)Database · 1 repos
databasenameDatabase · 1 repos

For agents

$ claude mcp add compose-generator \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact