Overview

tailspin is a command line tool for viewing (and tail-ing) log files. It highlights important keywords to make navigating log files easier.

tailspin is fast and easy to customize. It uses less under the hood to provide scrollback, search and filtering.

Installing

Homebrew

# Install
cargo install --path . 

# View log file
spin [file]

# Tail log file
spin [file] -f

Highlight Groups

Dates

Keywords

URLs

Numbers

IP Addresses

Quotes

Unix file paths

UUIDs

Customizing highlight groups

Overview

tailspin uses a single config.toml file to configure all highlight groups. When customizing highlights it is advised to start with the tailspin generate-config command to place a config.toml with default options in ~/.config/tailspin.

To disable a highlight group, either comment it out or delete it.

Highlights have the following shape:

style = { fg = "color", bg = "color", italic = false, bold = false, underline = false }

Adding keywords

To add custom keywords, either include them in the list of keywords or add new entries:

[[groups.keywords]]
words = ['MyCustomKeyword']
style = { fg = "green" }

[[groups.keywords]]
words = ['null', 'true', 'false']
style = { fg = "red", italic = true }

Settings

# Commands
generate-config    Create a custom config file at ~/.config/tailspin

# Options
-f, --follow       Follow (tail) the contents of the file
    --config       Provide a custom path configuration file