npmpackage.info

Gathering detailed insights and metrics for @rkesters/dockerode-compose

@rkesters/dockerode-compose - 1.2.3 | npmpackage.info

@rkesters/dockerode-compose

docker-compose in Node.js using dockerode

1.2.3

158

Apache-2.0

JavaScript

71.13 kB

3.2

Installations

npm install @rkesters/dockerode-compose

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.17.0

NPM Version

7.17.0 Pull Requests

Open

4

Total

25

Closed

5

Merged

16

Issues

Open

15

Total

24

Closed

9

Releases

v1.4.0

Updated on Oct 11, 2023

v1.3.3

Updated on May 19, 2023

v1.3.2

Updated on Aug 19, 2022

v1.3.1

Updated on Apr 13, 2022

v1.2.2

Updated on Oct 04, 2021

v1.2.1

Updated on May 21, 2021

View All 10 releases

Languages

JavaScript

Dockerfile

JavaScript (98.75%)

Dockerfile (1.25%)

Developer

apocas

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

158 Stars

128 Commits

33 Forks

9 Watchers

1 Branches

11 Contributors

Updated on Jun 29, 2025

Maintainers

View All 11 Contributors

Package Meta Information

Latest Version

1.2.3

Package Id

@rkesters/dockerode-compose@1.2.3

Unpacked Size

71.13 kB

Size

17.00 kB

File Count

NPM Version

7.17.0

Node Version

14.17.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

dockerode js-yaml tar-fs

Dev Dependencies

chai memorystream mocha typescript @types/dockerode

dockerode-compose

docker-compose in Node.js using dockerode.

Everything is executed programmatically using dockerode, consequently Docker's API.

ToDo:

Finish compose spec
User friendly functions (partial deploys, etc) needs to be implemented.

Installation

npm install dockerode-compose

Getting started

To use dockerode-compose first you need to instantiate it:

1var Dockerode = require('dockerode');
2var DockerodeCompose = require('dockerode-compose');
3
4var docker = new Dockerode();
5var compose = new DockerodeCompose(docker, './test/wordpress.yml', 'wordpress');
6
7(async () => {
8  await compose.pull();
9  var state = await compose.up();
10  console.log(state);
11})();

Documentation

new DockerodeCompose(dockerode, file, project_name)
compose.up()
compose.pull(service, options) - omit service to pull all images, options.streams return the streams without waiting, options.verbose pipe the streams to stdout.

Tests

Tests are implemented using mocha and chai. Run them with npm test.

Examples

Check the examples folder for more specific use cases examples.

License

Pedro Dias - @pedromdias

Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:

http://www.apache.org/licenses/LICENSE-2.0.html

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/apocas/dockerode-compose/node.js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/apocas/dockerode-compose/node.js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/apocas/dockerode-compose/node.js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/node.js.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/apocas/dockerode-compose/node.js.yml/main?enable=pin
Warn: containerImage not pinned by hash: test/assets/complex_example/2-nodejs-projects/simple-node-app-1235/Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: containerImage not pinned by hash: test/assets/complex_example/2-nodejs-projects/simple-node-app-1235/simple-node-app-1236/Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: containerImage not pinned by hash: test/assets/complex_example/2-nodejs-projects/simple-node-app/Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: containerImage not pinned by hash: test/assets/test_build/backend.Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: containerImage not pinned by hash: test/assets/test_build/backend/Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: containerImage not pinned by hash: test/assets/test_build/build_things/Dockerfile:1: pin your Docker image by updating ubuntu to ubuntu@sha256:440dcf6a5640b2ae5c77724e68787a906afb8ddee98bf86db94eea8528c2c076
Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:36
Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 6 containerImage dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More