# orc-runner

Latest version **0.1.5** (published 2018-12-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install orc-runner
pnpm add orc-runner
yarn add orc-runner
bun add orc-runner
```

Provides the command `orc-generator`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2018-12-20 |
| First published | 2018-07-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 25.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | craftybones, maheshkkolla |

## Links

- npm: https://www.npmjs.com/package/orc-runner
- Repository: https://github.com/step/orc-runner
- Homepage: https://github.com/step/orc-runner#readme
- Issues: https://github.com/step/orc-runner/issues
- npm.io page: https://npm.io/package/orc-runner

## Dependencies (5)

- [amqplib](https://npm.io/package/amqplib.md) ^0.5.2
- [request](https://npm.io/package/request.md) ^2.87.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.2
- [mustache](https://npm.io/package/mustache.md) ^2.3.0
- [scaffold-generator](https://npm.io/package/scaffold-generator.md) ^2.0.3

## Recent versions

- 0.1.5 (latest) — 2018-12-20
- 0.1.4 — 2018-08-10
- 0.1.3 — 2018-08-10
- 0.1.2 — 2018-08-07
- 0.1.1 — 2018-08-07
- 0.1.0 — 2018-07-27
- 0.0.9 — 2018-07-18
- 0.0.8 — 2018-07-16
- 0.0.7 — 2018-07-14
- 0.0.6 — 2018-07-14
- 0.0.5 — 2018-07-12
- 0.0.4 — 2018-07-12
- 0.0.3 — 2018-07-12
- 0.0.2 — 2018-07-12
- 0.0.1 — 2018-07-12

## README

# Orc Generator and Runner


## Steps to create an Orc:


 - ``` npm install orc-runner -g ```
 
 - ``` orc-generator <name-of-the-Orc> ```
 
 - The scaffold of the Orc will be generated in the directory as the same name given
 
 - Run `npm install`
 
 - Change the rabbitmq config and sauron reports URL in config.json or set the respective env variables
 
 - Write the task in the specified code block in `task.js` file
 
    ``` 
    const shell = require("shelljs");
    shell.config.silent = true;
     
    export default function(data) {
        return new Promise(function(resolve, reject) {
            //write your code here
        });
    }
    ```
 - Need any extra dependencies ? run `npm install <dependency> --save`
 
 - Do not change `index.js` file

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