raphaelyancey / cli2compose

💻 Translates a Docker command line to docker-compose YAML

cli2compose

Translates

docker create \
  --name=nextcloud \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 443:443 \
  -v :/config \
  -v :/data \
  --restart unless-stopped \
  linuxserver/nextcloud

into

version: "2"
services:
  app:
    image: linuxserver/nextcloud
    container_name: nextcloud
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    ports:
      - 443:443
    volumes:
      - :/config
      - :/data
    restart: unless-stopped

Quick start

npx -q cli2compose docker run mariadb > docker-compose.yml

... or through the web ui!

Usage

CLI

npx -q cli2compose docker run mariadb > docker-compose.yml

Node.js

const cli2compose = require('cli2compose');
const yaml = cli2compose('docker run mariadb');
console.log(yaml);

Browser

<script src="https://unpkg.com/cli2compose"></script>
<script>
    console.log(cli2compose('docker run mariadb'));
</script>

Supported input options

docker [create|run] [--volume|-v]
                    [--publish|-p]
                    [--network|--net]
                    [--restart]
                    [--expose]
                    [--env|-e]
                    [--links]
                    [--name] image [command]

cli2compose's Issues

Ignore options that have no impact on a compose file

... without having to list them in translations

Possible solution: remove all strings starting with either - or -- in the non-parsed arguments

Parsing

docker run --name elasticsearch -e "http.host=0.0.0.0" -e "ES_JAVA_OPTS=-Xms512m -Xmx512m" -d docker.elastic.co/elasticsearch/elasticsearch-oss:6.6.1

results in

version: "2"
services:
  app:
    image: -X
    command: -m -x -5 -1 -2 -m -"
      docker.elastic.co/elasticsearch/elasticsearch-oss:6.6.1
    container_name: elasticsearch
    environment:
      - '"http.host=0.0.0.0"'
      - '"ES_JAVA_OPTS=-Xms512m'