Skip to content

Commit

Permalink
Update README.md (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
arielkr256 authored Nov 13, 2024
1 parent abf39ec commit 1330fc8
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,13 @@ This is the `panther` backend for pySigma. It provides the package `sigma.backen

It supports the following output formats:

- default: [Panther YAML Detections](https://docs.panther.com/detections/rules/yaml#simple-detections) format
- python (`-f python`): [Panther Python Detections](https://docs.panther.com/detections/rules/python)

- default: [Panther Python Detections](https://docs.panther.com/detections/rules/python) format
- sdyaml (`-f sdyaml`): [Panther YAML Detections](https://docs.panther.com/detections/rules/yaml#simple-detections)
To save each rule in separate file you can use `output_dir` backend option.

> $ sigma convert -t panther -f sdyaml path/to/rules -p panther -O output_dir=output/directory
> $ sigma convert -t panther path/to/rules -p panther -O output_dir=output/directory
> or
> $ sigma convert -t panther -f python path/to/rules -p panther -O output_dir=output/directory
> $ sigma convert -t panther -f sdyaml path/to/rules -p panther -O output_dir=output/directory
Further, it contains the following processing pipelines in `sigma.pipelines.panther`:

Expand All @@ -33,7 +32,3 @@ Now you can run tests with:

To convert rules to panther sdyaml format run:
`poetry run sigma convert -t panther -f sdyaml -p panther path_to_sigma_rule.yml`

This backend is currently maintained by:

- [Oleh Melenevskyi](https://github.com/melenevskyi/)

0 comments on commit 1330fc8

Please sign in to comment.