npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

docker-machine-env

v1.0.6

Published

Get asynchronously the docker environment variables in a javascript object for further use

Downloads

10

Readme

docker-machine-env

Get asynchronously the docker environment variables in a javascript object for further use.

NPM

Use case

You want to use Docker with Node from Windows.

When you launch the Docker Quickstart Terminal, it sets some environment variables. When you're out of it, you have to run docker-machine env that prints you some commands to run to set environment variables.

The module docker-machine-env gets from this command the considered environment variables in a javascript object so that you can use it in child_process.exec for example.

Installation

npm install docker-machine-env

API documentation

You can use this module in both Batch or Shell context. docker-machine-env is promisifyable.

dockerMachineEnv([machine,] callback(err, envs))

machine

Type: String

The name of the docker machine you want the environment variables. Default to default.

callback(err, envs)

Type: Function

A callback for handling the variables.

err

Type: Error

contains errors thrown by the command, null if no error. You may not throw this error if docker-machine is not installed

envs

Type: Object

contains the environment variables as follow :

{
  DOCKER_TLS_VERIFY: '1',
  DOCKER_HOST: 'tcp://192.168.99.100:2376',
  DOCKER_CERT_PATH: 'C:\\Users\\MyUser\\.docker\\machine\\machines\\default',
  DOCKER_MACHINE_NAME: 'default' 
}

How to use

Getting the result of a docker ps

with child_process

var dockerMachineEnv = require('docker-machine-env');
var exec = require('child_process').exec;

dockerMachineEnv(function(err, envs){

	if(err)
	{
		//will throw an Error in the case docker-machine is not installed. 
		//depending where you use it, that may not be what you want
		throw err;
	}
	else
	{
		exec('docker ps', {env: envs}, (error, stdout, stderr) => {
		
			//you can print the result of docker ps
			console.log(stdout)
		})
	}
});

with dockerode


var Docker = require('dockerode');
var fs     = require('fs');
var dockerMachineEnv = require('docker-machine-env');

dockerMachineEnv(function(err, envs){

	//adding docker environment variables to the current process env
    Object.assign(process.env, envs);

	//this uses the process env previously defined
	var docker = new Docker(); 
	
	if(err)
	{
		//will throw an Error in the case docker-machine is not installed. 
		//depending where you use it, that may not be what you want
		throw err;
	}
	else
	{
		docker.listContainers({all: false}, function(err, containers) {
            console.log(containers);
        });
	}
});