# scriptz

> Configuration file based script runner

Latest version **2.0.0** (published 2018-07-23) · ISC license · 0 weekly downloads

## Install

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

Provides the command `scriptz`.

## 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 | 2.0.0 |
| Published | 2018-07-23 |
| First published | 2017-12-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 64.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ash Belmokadem |
| Maintainers | abelmokadem |
| Keywords | bash |

## Links

- npm: https://www.npmjs.com/package/scriptz
- Repository: https://github.com/abelmokadem/scriptz
- Homepage: https://github.com/abelmokadem/scriptz#readme
- Issues: https://github.com/abelmokadem/scriptz/issues
- npm.io page: https://npm.io/package/scriptz

## Dependencies (5)

- [rxjs](https://npm.io/package/rxjs.md) ^5.5.5
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [winston](https://npm.io/package/winston.md) ^3.0.0-rc1
- [commander](https://npm.io/package/commander.md) ^2.12.2
- [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^3.10.1

## Recent versions

- 2.0.0 (latest) — 2018-07-23
- 0.0.15 (beta) — 2017-12-12
- 1.0.0 — 2017-12-13
- 0.0.14 — 2017-12-12
- 0.0.13 — 2017-12-12
- 0.0.12 — 2017-12-11
- 0.0.11 — 2017-12-11
- 0.0.10 — 2017-12-11
- 0.0.9 — 2017-12-11
- 0.0.8 — 2017-12-11
- 0.0.7 — 2017-12-11
- 0.0.6 — 2017-12-11
- 0.0.5 — 2017-12-11
- 0.0.4 — 2017-12-11
- 0.0.3 — 2017-12-11
- … 2 more at https://npm.io/package/scriptz/versions

## README

# Scriptz
Configuration file based script runner

## Getting started (Code)
```bash
$ npm install --save scriptz
```

```javascript
const run = require('scriptz').run

run(configuration).subscribe(...) // Observable
```

## Getting started (CLI)
```bash
$ npm install -g scriptz
$ scriptz run --config config.yaml
```

Create a config file in yaml.

```yaml
options:
  retry_count: 3
  env:
    FOO: bar
start:
  name: Main
  flow: sequential
  steps:
    - name: Clean
      script: clean.sh
      arguments:
        - foo
      output_file: clean.log
      retry_count: 1
      env:
        FOO: Test
    - name: Install
      script: install.sh
      retry_count: 1
      output_file: install.log
```

See the full [documentation](./docs/README.md)

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