# surify-cli

> Generate suricata-rules from collection of IOCs (JSON, CSV or flags) based on your suricata template.

Latest version **0.0.8** (published 2019-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install surify-cli
pnpm add surify-cli
yarn add surify-cli
bun add surify-cli
```

Provides the command `surify-cli`.

## 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.0.8 |
| Published | 2019-03-29 |
| First published | 2019-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 27.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | dgenzer |
| Keywords | suricata, ids, rules, generator, template |

## Links

- npm: https://www.npmjs.com/package/surify-cli
- Repository: https://github.com/dgenzer/surify-cli
- npm.io page: https://npm.io/package/surify-cli

## Dependencies (2)

- [meow](https://npm.io/package/meow.md) ^5.0.0
- [csv-parse](https://npm.io/package/csv-parse.md) ^4.3.4

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2019-03-29
- 0.0.7 — 2019-03-26
- 0.0.6 — 2019-03-25
- 0.0.5 — 2019-03-20

## README

# surify-cli

Generate suricata-rules from collection of IOCs (JSON, CSV or flags) based on your suricata template.


## Installation
`# npm i -g surify-cli`

## Features

### Inputs
- CSV as input (only with header)
(_you have to manually set the delimiter_)
  - `$ surify c config.json --csv example.csv -d ";" -o suri_csv.rules --sid 1`
- JSON as input
  - `$ surify -c config.json --json example.json -o suri.rules`
- [JSON Lines](http://jsonlines.org/) as input (e.g. from [armbues/ioc-parser](https://github.com/armbues/ioc_parser))
  - `$ surify -c config.json --jsonl example.jsonl -o suri.rules`
- flags as input
  - `$ surify -c config.json --test1 1.2.3.4 --test2 9.9.9.9 --sid 120000 -o log`

### Outputs
- output to stdout 
  - `... -o log`
- output to file
  - `... -o suri.rules`

## Examples

An example `config.json` and some templates `./templates/*` are available. Further examples are available [here](https://github.com/dgenzer/surify-cli/wiki/Examples).

## ToDo
- [ ] Tests
- [x] conditions in **config.json**
  - [ ] Example in wiki
- [ ] **surify.js** as a standalone package
- [ ] autodetect inputtype

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