# @panda-clouds/docker-machine

> allows the use of docker-machine from node

Latest version **1.5.0** (published 2019-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @panda-clouds/docker-machine
pnpm add @panda-clouds/docker-machine
yarn add @panda-clouds/docker-machine
bun add @panda-clouds/docker-machine
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2019-08-21 |
| First published | 2019-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 1 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marc Smith |
| Maintainers | mrmarcsmith |

## Links

- npm: https://www.npmjs.com/package/@panda-clouds/docker-machine
- Repository: https://github.com/panda-clouds/docker-machine
- Homepage: https://github.com/panda-clouds/docker-machine#readme
- Issues: https://github.com/panda-clouds/docker-machine/issues
- npm.io page: https://npm.io/package/@panda-clouds/docker-machine

## Dependencies (1)

- [@panda-clouds/parse-bash](https://npm.io/package/@panda-clouds/parse-bash.md) ^2.1.0

## Recent versions

- 1.5.0 (latest) — 2019-08-21
- 1.4.0 — 2019-08-15
- 1.3.1 — 2019-08-14
- 1.3.0 — 2019-08-14
- 1.2.0 — 2019-08-14
- 1.1.0 — 2019-03-24
- 1.0.0 — 2019-03-23

## README

PCDockerMachine
=========
maintained by [PandaClouds.com](https://pandaclouds.com)

`PCDockerMachine` provides a clean way to validate data in Parse Sever Cloud Code.


Installation
------------

1. If you want to use this library, you first need to install the [Node.js](https://nodejs.org/en/).

2. When you install node.js, will also be installed [npm](https://www.npmjs.com/).

3. Please run the following command.

```
npm install --save @panda-clouds/docker-machine
```

Usage
-----

### Node.js

```javascript
const PCDockerMachine = require('@panda-clouds/docker-machine');

const options = {};
options['digitalocean-access-token'] = '< my DigitalOcean Token >';

// Create the machine on Digital Ocean
const machine = await DockerMachine.create('machine-test', 'digitalocean', options);

const status = await machine.status();  // => 'Running'
const IPv4 = await machine.getIPv4();   // => '123.234.321.21'
const allMachines = await Machine.ls(); // => [{'name':'machine-test'...},{'name':'other-machine'...}]

// Destroy the machine 
await machine.destroy();

const status = await machine.status(); // => 'Machine Not Found'
```

You can replace PCDockerMachine with any variable.


Methods
-------

[Unit Tests] are an additional resource for learning functionality.

### - status()

returns the status of the machine

Example:

```javascript
const status = await machine.status() // => 'Running'
```



Contributions
-------------

Pull requests are welcome! here is a checklist to speed things up:

- modify `PCDockerMachine.js`
- add unit tests in `PCDockerMachine.spec.js`
- run `npm test`
- document method in `README.md`
- add your name to 'Contributors' in `README.md`


### Contributors

(Add your name)

- [*] [Marc Smith](https://github.com/mrmarcsmith)


[Unit Tests]: https://github.com/panda-clouds/string/blob/master/spec/PCDockerMachine.spec.js

---
_Source: https://npm.io/package/@panda-clouds/docker-machine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._