TSPIN(1) tailspin TSPIN(1) NAME tspin - A log file highlighter SYNOPSIS tspin [OPTION]... [FILE]... DESCRIPTION tailspin is a command line tool that highlights log files. OPTIONS -f, --follow Follow (tail) the contents of the file. Always true when using the --exec flag. -p, --print Print the output to stdout instead of viewing the contents in the pager less. Always true if using stdin. --config-path CONFIG_PATH Specify the path to a custom configuration file. Defaults to XDG_CON- FIG_HOME/tailspin/theme.toml or ~/.config/tailspin/theme.toml if not set. -e, --exec COMMAND Run command and view the output in a pager. The command traps the in- terrupt signal to allow for cancelling and resuming follow mode while inside less. Example: tspin --exec 'kubectl logs -f pod_name' --highlight COLOR1:word1,word2,... COLOR2:word3,word4,... Highlight the provided comma-separated words in the specified color. Possible colors are red, green, yellow, blue, magenta, and cyan. Example: tspin logfile.txt --highlight red:error,fail --highlight green:success,ok --enable=[HIGHLIGHT_GROUP] Disable all highlighting groups except the ones specified. Comma sepa- rated list of groups. Cannot be used with --disable=[HIGHLIGHT_GROUP]. Possible groups: numbers, urls, emails, pointers, dates, paths, quotes, key-value-pairs, uuids, ipv4, processes, json. --disable=[HIGHLIGHT_GROUP] Disable the specified highlighting groups. Comma separated list of groups. Cannot be used with --enable=[HIGHLIGHT_GROUP]. Possible groups: numbers, urls, emails, pointers, dates, paths, quotes, key-value-pairs, uuids, ipv4, processes, json. --extras=[EXTRA] Enable extra highlighters. Comma separated list of extras. Possible values: ipv6, jvm-stack-trace. Can also be set via the TAILSPIN_EXTRAS environment variable. --pager COMMAND Override the default pager command used by tspin. The command must in- clude the string [FILE] which will be replaced with the file path in- ternally. Example: tspin logfile.txt --pager "ov -f [FILE]" --disable-builtin-keywords Disables the highlighting of all builtin keyword groups (booleans, nulls, log severities and common REST verbs). ENVIRONMENT VARIABLES TAILSPIN_PAGER Set the TAILSPIN_PAGER environment variable to override the default pager. Equivalent to the --pager flag. The command must include the string [FILE] which will be replaced with the file path internally. For example, "ov -f [FILE]". TAILSPIN_EXTRAS Comma separated list of extras to enable by default. Equivalent to the --extras flag. For example, "jvm-stack-trace" or "ipv6,jvm-stack-trace". SEE ALSO less(1), tail(1) ABOUT Ben Sadeh (github.com/bensadeh/tailspin) Released under the MIT License tailspin 6.1.0 2026-05-14 TSPIN(1)
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | ENVIRONMENT VARIABLES | SEE ALSO | ABOUT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=tspin&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>