From 44f0e9eeb3150fede7c3ccfc91adaaf1b280d348 Mon Sep 17 00:00:00 2001 From: Michael James Date: Thu, 6 May 2021 22:12:39 -0600 Subject: [PATCH] docs: Add details of execPath option --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index 0ccd8f6..110dc7c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -74,6 +74,7 @@ compose.exec('node', 'npm install', { cwd: path.join(__dirname) }) `docker-compose` accepts these params: * `cwd {string}`: mandatory folder path to the `docker-compose.yml` +* `execPath {string}`: optional path to docker-compose exec in case it's not located in $PATH `/path/to/docker-compose` * `config {(string|string[])}`: custom and/or multiple yml files can be specified (relative to `cwd`) * `configAsString {string}`: configuration can be provided as is, instead of relying on a file. In case `configAsString` is provided `config` will be ignored. * `[log] {boolean}`: optional setting to enable console logging (output of `docker-compose` `stdout`/`stderr` output)