create-compose

Create Compose CLI

Used to quickly scaffold a Docker Compose file in a new project

• Usage
• Commands

Usage

$ npm install -g create-compose
$ create-compose COMMAND
running command...
$ create-compose (--version)
create-compose/0.3.5 linux-x64 node-v17.9.0
$ create-compose --help [COMMAND]
USAGE
  $ create-compose COMMAND
...

Commands

• create-compose

create-compose

Create a compose.yml file

USAGE
  $ create-compose [--postgres-container-name <value> -p] [--redis-container-name <value> -r] [--vite-container-name
    <value> -v] [--node-container-name <value> -t] [--adminer-container-name <value> -a]

ADMINER FLAGS
  -a, --adminer                     full-featured database management tool
  --adminer-container-name=<value>  [default: adminer]

POSTGRES FLAGS
  -p, --postgres                     Postgres database
  --postgres-container-name=<value>  [default: postgres]

REDIS FLAGS
  -r, --redis                     Redis service
  --redis-container-name=<value>  [default: redis]

NODE FLAGS
  -t, --node                     run ts-node-dev on the current directory
  --node-container-name=<value>  [default: node]

VITE FLAGS
  -v, --vite                     run vite dev server
  --vite-container-name=<value>  [default: vite]

DESCRIPTION
  Create a compose.yml file

EXAMPLES
  $ create-compose --postgres --redis
      Created compose.yaml

FLAG DESCRIPTIONS
  -a, --adminer  full-featured database management tool

    Creates a adminer service

  -p, --postgres  Postgres database

    Creates a postgres service

  -r, --redis  Redis service

    Creates a redis service

  -t, --node  run ts-node-dev on the current directory

    Creates a node service

  -v, --vite  run vite dev server

    Creates a vite service

See code: src/commands/index.ts