bensadeh / tailspin

A log file highlighter Features • 🪵 View (or ) any log file of any format • 🍰 No setup or config required • 🌈 Highlights numbers, dates, IP-addresses, UUIDs, URLs and more • ⚙️ All highlight groups are customizable • 🧬 Easy to integrate with other commands • 📦 Also available as a crate Table of Contents • Overview • Usage • Installing • Highlight Groups • Customizing Highlight Groups • Working with and • Using the pager • Settings *** Overview works by reading through a log file line by line, running a series of regexes against each line. The regexes recognize patterns you expect to find in a logfile, like dates, numbers, severity keywords and more. does not make any assumptions on the format or position of the items it wants to highlight. For this reason, it requires no configuration and the highlighting will work consistently across different logfiles. Usage The binary name for is . Installing Expand to view Package Managers From Source Binary will be placed in , make sure you add the folder to your environment variable. > [!IMPORTANT] > When building from source, make sure that you are using the latest version > of . Highlight Groups Dates Keywords URLs Numbers IP Addresses Quotes Unix file paths HTTP methods UUIDs Key-value pairs Pointer addresses Unix processes Customizing Highlight Groups Overview Create a in to customize highlight groups. Styles have the following shape: To edit the different highlight groups, include them in your file. For example, to edit the highlight group, add the following to your : Expand the section below to see the default config for the highlight groups: Default highlight groups settings Disabling Highlight Groups To individually disable or enable highlight groups, use the and flags: Adding Keywords via theme.toml To add custom keywords, either include them in the list of keywords or add new entries: Adding Keywords from the command line Sometimes it is more convenient to add highlight groups on the fly without having to edit a TOML. To add highlights from the command line, use the flag followed by a comma separated list of words to be highlighted. For example: Custom regex highlighters When you need more control over the highlighting, you can use the regex highlighter. This highlighter allows you to specify a regex and a style to be applied to the matched text. It supports one capture group . When found, it will apply the style to the captured text. Working with and Default behavior with pipes By default, will open a file in the pager . However, if you pipe something into , it will print the highlighted output directly to . This is similar to running . To let highlight the logs of different commands, you can pipe the output of those commands into like so: Capturing the output of a command and viewing it in To capture the output of a command and view it in , use the flag: This will run the command in the background and pipe the output to . The output will be displayed in , allowing you to navigate and search through the logs. Using the pager Overview uses as its pager to view the highlighted log files. You can get more info on via the **man** command ( ) or by hitting the h button to access the help screen. Navigating Navigating within uses a set of keybindings that may be familiar to users of or other -like editors. Here's a brief overview of the most useful navigation commands: • j / k : Scroll one line up / down • d / u : Scroll one half-page up / down • g / G : Go to the top / bottom of the file Follow mode When you run with the or flag, it will scroll to the bottom and print new lines to the screen as they're added to the file. To stop following the file, interrupt with Ctrl + C . This will stop the tailing, but keep the file open, allowing you to review the existing content. To resume following the file from within , press Shift + F . Search Use / followed by your search query. For example, finds the first occurrence of **ERROR**. After the search, n finds the next instance, and N finds the previous instance. Filtering allows filtering lines by a keyword, using & followed by the pattern. For instance, shows only lines with **ERROR**. To only show lines containing either or , use a regular expression: . To clear the filter, use & with no pattern. Custom pagers Set the environment variable to override the default pager. The command must include the string **[FILE]** which will be replaced with the file path internally. For example: Settings