From d14d7edff5560485ee58d7e6b78b45ae3566b996 Mon Sep 17 00:00:00 2001 From: weslambert Date: Mon, 13 Mar 2023 17:29:50 -0400 Subject: [PATCH] Add information about alternative output formats --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5b99006..6de396e 100644 --- a/README.md +++ b/README.md @@ -69,3 +69,17 @@ and compile the code yourself by running: `go build`. ./ChopChopGo -target syslog -rules ./rules/linux/builtin/syslog/ # This searches through syslog with the official sigma rules ./ChopChopGo -target journald -rules ./rules/linux/builtin/ # This searches through journald with specified rules ``` +#### Alternative Output Formats +You may wish to use ChopChopGo in an automated fashion. The CSV and JSON output options are useful for this purpose. With both of these options, the header and progress statistics are not printed to the console. + +Each option can be specific using the `-out` parameter. + +##### CSV + +```bash +./ChopChopGo -target sylog -rules ./rules/linux/builtin/syslog/ -out csv # This searches through syslog with the official sigma rules, then outputs the data in CSV format +``` +##### JSON +```bash +./ChopChopGo -target syslog -rules ./rules/linux/builtin/syslog/ -out json # This searches through syslog with the official sigma rules, then outputs the data as JSON +```