omarandstuff/desplega-api

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<h1 align="center">
  <img src="https://raw.githubusercontent.com/omarandstuff/desplega-api/master/media/desplega-logo.png" alt="Desplega-api" title="Desplega-api" width="512">
</h1>

[![npm version](https://badge.fury.io/js/desplega-api.svg)](https://www.npmjs.com/package/desplega-api)
[![Build Status](https://travis-ci.org/omarandstuff/desplega-api.svg?branch=master)](https://travis-ci.org/omarandstuff/desplega-api)
[![Maintainability](https://api.codeclimate.com/v1/badges/c7a58bcf312d8c47c4fa/maintainability)](https://codeclimate.com/github/omarandstuff/desplega-api/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/c7a58bcf312d8c47c4fa/test_coverage)](https://codeclimate.com/github/omarandstuff/desplega-api/test_coverage)

Desplega api is a series of useful modules to create rich automation pipelines.

## API

### Console Logger
Fancy pipeline logger for the console

### Local
Local commands executer.

### LocalStep
Can be executed by a pipeline as a local command in the pipeline.

### Parser
Parses files and convert them into actual Pipelines with Steps objects.

### Pipeline
Object to manage the whole exec process.

### Pipeline Logger
It takes a pipeline listens to it and provide call backs for events

### Remote
Remote ssh commands executer.

### RemoteStep
Can be executed by a pipeline as a remote command in the pipeline.

### Virtual
Async functions executer.

### VirtualStep
Can be executed by a runner as a virtual command in the pipeline.

## Contribtions
PRs are welcome.

## Lisence
MIT