# supervisord

> Supervisord library for node.js

Latest version **0.1.0** (published 2015-12-23) · 0 weekly downloads

## Install

```sh
npm install supervisord
pnpm add supervisord
yarn add supervisord
bun add supervisord
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-12-23 |
| First published | 2011-09-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 65 |
| Author | Craig Condon |
| Maintainers | architectd |

## Links

- npm: https://www.npmjs.com/package/supervisord
- Repository: https://github.com/crcn/node-supervisord
- Homepage: https://github.com/crcn/node-supervisord#readme
- Issues: https://github.com/crcn/node-supervisord/issues
- npm.io page: https://npm.io/package/supervisord

## Dependencies (2)

- [xmlrpc](https://npm.io/package/xmlrpc.md) *
- [structr](https://npm.io/package/structr.md) *

## Recent versions

- 0.1.0 (latest) — 2015-12-23
- 0.0.5 — 2015-12-11
- 0.0.4 — 2013-11-06
- 0.0.3 — 2012-02-17
- 0.0.2 — 2011-09-18
- 0.0.1 — 2011-09-17

## README

### What's this?

A node.js library for [supervisord](http://supervisord.org/). If you're not familiar with supervisord, it's much like [forever](https://github.com/indexzero/forever), [launchd](http://en.wikipedia.org/wiki/Launchd), upstart+monit, etc. 



### Requirements


- Node.js 
- Supervisord 
- NPM

### Installation

	npm install supervisord


### Example:


```javascript

	var supervisord = require('supervisord');

	var client = supervisord.connect('http://localhost:9001');


	client.startProcess('my-app', function(err, result)
	{
		
	});
	
	//return all running processes by supervisord
	client.getAllProcessInfo(function(err, result)
	{
		console.log(result);

		/*
		[ { description: 'pid 22083, uptime 0:10:36',
	    pid: 22083,
	    stderr_logfile: '/tmp/test-stderr---supervisor-G27SFc.log',
	    stop: 1316236587,
	    logfile: '/tmp/test-stdout---supervisor-izrtu6.log',
	    exitstatus: 0,
	    spawnerr: '',
	    now: 1316237455,
	    group: 'app-1',
	    name: 'app-1',
	    statename: 'RUNNING',
	    start: 1316236819,
	    state: 20,
	    stdout_logfile: '/tmp/test-stdout---supervisor-izrtu6.log' } ]
    	*/
	});

```


### [Available Methods](http://supervisord.org/api.html?highlight=api):

- getSupervisorVersion()
- getIdentification()
- getState()
- getPID()
- readLog()
- clearLog()
- shutdown()
- restart()
- getAllProcessInfo(name)
- startProcess(name)
- startAllProcesses()
- startProcessGroup()
- stopProcessGroup()
- sendProcessStdin()
- sendRemoteCommEvent()
- addProcessGroup(name)
- removeProcessGroup(name)
- readProcessStdoutLog(name)
- readProcessStderrLog(name, offset, length)
- tailProcessStdoutLog(name, offset, length)
- tailProcessStderrLog(name, offset, length)
- clearProcessLogs(name)
- clearAllProcesssLogs()
- signalProcess(name, signal)
- signalProcessGroup(name, signal)

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