Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add readme from output of --help #29

Merged
merged 1 commit into from
Jan 25, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Pipe through standard input while highlighting and keeping track of delays between lines

Usage: txt-timer [OPTIONS]

Options:
-q, --quiet
do not output stdin
-c, --count <COUNT>
number of top differences to print at the end [default: 5]
-B, --lines-before <LINES_BEFORE>
[default: 5]
--color
colorized output
--color-range <COLOR_RANGE>
range for color scale of delay, in seconds [default: 0.2]
--time-regex <TIME_REGEX>
use regex to extract timestamp from lines instead of using real time, must have one (?<time> ) named capturing group
--time-regex-format <TIME_REGEX_FORMAT>
format of timestamp, without timezone see `strftime`. Example `%Y-%m-%d %H:%M:%S%.3f`
-p, --prepend-time
prepend time to output
-o, --output-maximals <OUTPUT_MAXIMALS>
redirect output of maximum differences to a file
--async-buffer-line-count <ASYNC_BUFFER_LINE_COUNT>
buffer size for asynchronous processing [default: 128]
-h, --help
Print help (see more with '--help')
Loading