Skip to content

Commit cddfad8

Browse files
committed
README: Add note about default input format
New users expecting klp to guess the input format might be confused about its default behaviour of trying to parse the logfmt-like parts of the logs.
1 parent 2d1dc8d commit cddfad8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,11 @@ Or you can read from a file:
114114
$ klp log.txt
115115
```
116116

117+
> [!NOTE]
118+
> klp defaults to the [logfmt](https://brandur.org/logfmt) format and will extract any `key=value` patterns it finds,
119+
> even if the file is in a different format.
120+
> For non-logfmt logs, specify the format explicitly (e.g. `-f syslog`, or `-f line` for plain text).
121+
117122
klp can directly process compressed log files:
118123

119124
```bash

0 commit comments

Comments
 (0)