Skip to content

Commit 70b184f

Browse files
committed
README: Move note up, to the quickstart section
1 parent cddfad8 commit 70b184f

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@ $ klp -S mylog.logfmt
100100
$ tail -f mylog.logfmt | klp -n
101101
```
102102

103+
> [!NOTE]
104+
> klp defaults to the [logfmt](https://brandur.org/logfmt) input format and will extract any `key=value` patterns it finds,
105+
> even if the file is in a different format.
106+
> For non-logfmt logs, specify the format explicitly (e.g. `-f syslog`, or `-f line` for plain text).
107+
108+
103109
### Basic Usage
104110

105111
klp can be used as a filter, reading from stdin:
@@ -114,11 +120,6 @@ Or you can read from a file:
114120
$ klp log.txt
115121
```
116122

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-
122123
klp can directly process compressed log files:
123124

124125
```bash

0 commit comments

Comments
 (0)