Skip to content

Commit

Permalink
Fix README typos and clarify (#132)
Browse files Browse the repository at this point in the history
* Fix typo and clarify text
  • Loading branch information
stephen-soltesz committed Jul 7, 2022
1 parent 21aaf43 commit 9928ad3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -41,7 +41,7 @@ implementation `cmd/example-eventsocket-client` can be started using
`docker-compose`.

```bash
docker-compse up
docker-compose up
```

New TCP events are processed by the `example-eventsocket-client` sidecar and
Expand Down
16 changes: 11 additions & 5 deletions cmd/csvtool/README.md
@@ -1,15 +1,21 @@
# csvtool

The csvtool is intended to convert from ArchiveRecord files to CSV files.
It currently only handles raw or zstd compressed JSONL files as source.
It takes a single command line argument, which is the name of the file, or "-" to read uncompressed JSONL from stdin.
The csvtool is intended to convert the ArchiveRecord file format produced by
tcp-info to more easily usable CSV files. csvtool currently only handles
individual, raw or zstd compressed JSONL files as a source. Named files should
be the only parameter. If reading uncompressed JSONL from STDIN, provide no
argument.

## Examples:
## Examples

Decompressing the JSONL file so that csvtool reads from stdin:

```bash
zstd -cd 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst | ./csvtool - > connection.csv
zstd -cd 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst | ./csvtool > connection.csv
```

Directly read compressed format:

```bash
./csvtool 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst > connection.csv
```

0 comments on commit 9928ad3

Please sign in to comment.