better-decomposerize

https://decomposerize.com - Turns Docker Compose files into docker run commands.

Looking for the reverse? https://composerize.com / Composerize

Want to convert between Docker Compose file formats? https://composeverter.com / Composeverter

CLI

Install globally:

npm install -g better-decomposerize

The installed command is still:

decomposerize

Basic usage:

decomposerize docker-compose.yml

Options can be placed before the compose file:

decomposerize --docker-run --multiline docker-compose.yml

If input is piped or redirected, the CLI reads from stdin:

cat docker-compose.yml | decomposerize --docker-run
decomposerize --docker-run < docker-compose.yml

If neither a compose file nor stdin input is provided, the CLI exits with an error and prints the help message.

CLI options

Usage: decomposerize [options] <compose-file>

• --help, -h
• --services=service1,service2
• --docker-run
• --docker-run-command=<cmd>
• --docker-run-rm
• --docker-run-detach
• --docker-build
• --stop-and-remove
• --create-volumes
• --create-networks
• --delete-images
• --ansible-env-vars-format
• --multiline
• --long-args
• --arg-value-separator=<sep>

API

The package exports a function:

const decomposerize = require('better-decomposerize');

Signature

decomposerize(dockerComposeContent, configuration = {})

• dockerComposeContent: a string containing the Docker Compose YAML.
• configuration: optional configuration object.

Supported configuration fields:

• services: string[]
• stopAndRemoveContainers: boolean
• createVolumes: boolean
• createNetworks: boolean
• dockerBuild: boolean
• dockerRun: boolean
• dockerRunCommand: string
• dockerRunRm: boolean
• dockerRunDetach: boolean
• deleteImages: boolean
• ansibleEnvVarsFormat: boolean
• multiline: boolean
• 'long-args': boolean
• 'arg-value-separator': ' ' | '='

Example

const decomposerize = require('better-decomposerize');

const dockerComposeInput = `
version: '3'
services:
  myapp:
    image: myapp-image
`;

const configuration = {
  dockerRun: true,
  dockerRunCommand: 'docker run',
  dockerRunRm: true,
  dockerRunDetach: false,
  multiline: true,
  'long-args': false,
  'arg-value-separator': ' ',
};

const output = decomposerize(dockerComposeInput, configuration);

console.log(output);

Development

This package uses make for common tasks:

make eslint
make test
make build
make rebuild
make release
make publish

Build outputs

• dist/decomposerize.js → library bundle
• dist/cli.bundle.js → bundled npm CLI
• dist/decomposerize → standalone executable built with Node SEA

Standalone binary

Build the standalone executable:

make release

Run it:

./dist/decomposerize docker-compose.yml

Install it system-wide:

sudo make install

Install it under a custom prefix:

make install PREFIX=$HOME/.local

Uninstall it:

sudo make uninstall
make uninstall PREFIX=$HOME/.local

Contributing

• Clone a fork of the repo and install dependencies with yarn
• Make your changes and build them with make build
• Run make test

Maintainers

• MatrixDJ96 GitHub
• Fork project: Shawiizz GitHub
• Original project: ShareVB GitHub

License

MIT