Terminal user interface for reading logs from journald, auditd, file system, Docker containers, Podman and Kubernetes pods for quick viewing, coloring output and filtering with fuzzy find, regex support and timestamp. Written in Go with the awesome-gocui (fork gocui) library.

This tool is inspired by and with love for LazyDocker and LazyGit. It is also included in Awesome-Go, Awesome-TUIs and Awesome-Docker, check out other useful projects on the repository pages.

Features

• Simple installation, to run download one executable file without dependencies and settings.
• Centralized search for the required journal by filtering all lists (log sources).
• Streaming output of new events from the selected journal (like tail).
• List of all units (services, sockets, etc.) with current running status via systemctl from systemd.
• View all system and user journals via journalctl (tool for reading logs from journald).
• List of all system boots for kernel log output.
• List of audit rules from auditd for filtering by keys and viewing in interpret format.
• File system logs such as for Apache or Nginx, as well as syslog, messages, etc. from /var/log.
• Lists all log files in users home directories, as well as descriptor log files used by processes.
• Reading archive logs truncated during rotation (gz, xz and bz2 formats), Packet Capture (pcap format) and Apple System Log (asl format).
• Search and analyze all logs from remote hosts in one interface using rsyslog configuration.
• Docker logs, including archive logs, timestamp and all streams.
• Podman logs, without the need to run a background process (socket).
• Kubernetes pods (need to configure a connection to the cluster via kubectl in advance).
• Windows Event Logs via PowerShell and wevtutil, as well as application logs from Windows file system.

Filtering

Supports 4 filtering modes:

• Default - case sensitive exact search.
• Fuzzy (like fzf) - custom inexact case-insensitive search (searches for all phrases separated by a space anywhere on a line).
• Regex (like grep) - search with regular expression support, based on the built-in regexp library, case-insensitive by default (in case a regular expression syntax error occurs, the input field will be highlighted in red).
• Timestamp - filter since and/or until by date and time for journald, docker and podman logs from streams. This mode affects the loading of the log (thereby increasing performance) and can be used in conjunction with other filtering modes, so the current log should be reloaded by pressing Enter in the current input field.

Supported formats for timestamp:

• 00:00
• 00:00:00
• 2025-04-14
• 2025-04-14 00:00
• 2025-04-14 00:00:00

Coloring

Supported coloring groups for output:

• Custom - URLs, file paths and processes in UNIX.
• Yellow - known names (host name and system users) and warnings.
• Green - keywords indicating success.
• Red - keywords indicating error.
• Blue - statuses (info, debug, etc), actions (install, update, etc) and HTTP methods (GET, POST, etc).
• Light blue - numbers (date, time, timestamp, bytes, versions, percentage, integers, IP and MAC addresses).

A full list of all keywords can be found in the color.log file (used for testing only). If you have suggestions for improving coloring (e.g. adding new words), you can open an issue for a new feature.

Coloring directly affects the loading time of the log, to increase the performance of reading large logs, it is possible to disable coloring using the Ctrl+Q.

Install

Binaries are available for download on the releases page.

List of supported systems and architectures in which functionality is checked:

OS	amd64	arm64	Systems
Linux	✔	✔	Raspberry Pi (aarch64), Oracle Linux (RHEL-based in WSL environment), Arch Linux, Rocky Linux, Ubuntu Server 20.04.6 and above.
Darwin	✔	✔	macOS Sequoia 15.2 x64 on MacBook and the arm64 in GitHub Actions.
BSD	✔		OpenBSD 7.6 and FreeBSD 14.2.
Windows	✔		Windows 10 and 11.

Unix-based

Run the command in the console to quickly install or update the stable version for Linux, macOS or the BSD-based system:

curl -sS https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.sh | bash

This command will run a script that will download the latest executable from the GitHub repository into your current user's home directory along with other executables (or create a directory) and grant execution permission.

Debian / Ubuntu

If you are using a Debian-based system, you can also use the deb package to manage installation and removal:

arch=$( [ "$(uname -m)" = "aarch64" ] && echo "arm64" || echo "amd64" )
version=$(curl -L -sS -H 'Accept: application/json' https://github.com/Lifailon/lazyjournal/releases/latest | sed -e 's/.*"tag_name":"\([^"]*\)".*/\1/')
curl -L -sS https://github.com/Lifailon/lazyjournal/releases/download/$version/lazyjournal-$version-$arch.deb -o /tmp/lazyjournal.deb
sudo apt install /tmp/lazyjournal.deb # or sudo dpkg -i /tmp/lazyjournal.deb

Eget

You can use the universal way to install the latest version binaries from the GitHub repository using eget:

eget lifailon/lazyjournal --to ~/.local/bin

Arch Linux

If you an Arch Linux user you can also install from the AUR:

paru -S lazyjournal

Conda / mamba / pixi (Linux / macOS / Windows)

If you use package managers like conda or mamba, you can install lazyjournal from conda-forge:

conda install -c conda-forge lazyjournal
mamba install -c conda-forge lazyjournal

You can install lazyjournal user-globally using pixi:

pixi global install lazyjournal

Homebrew (macOS / Linux)

Use the following command to install lazyjournal using Homebrew:

brew install lazyjournal

Docker (Debian-based)

To run the interface in a container, download docker-compose and use the image from Docker Hub:

mkdir lazyjournal && cd lazyjournal
curl -sS https://raw.githubusercontent.com/Lifailon/lazyjournal/main/docker-compose.yml -o docker-compose.yml
curl -sS https://raw.githubusercontent.com/Lifailon/lazyjournal/main/.env -o .env
docker-compose up -d
docker exec -it lazyjournal lazyjournal

The image is based on Debian with systemd and docker cli pre-installed. The necessary read-only permissions are already preset in docker-compose to support all log sources from the host system (review it to customize for your individual use).

Supports running in the Web interface via ttyd. To do this, edit the variables in the .env file:

TTYD=true
PORT=5555
# Credentials for accessing the Web interface (optional)
USERNAME=admin
PASSWORD=admin

Windows

Use the following command to quickly install in your PowerShell console:

irm https://raw.githubusercontent.com/Lifailon/lazyjournal/main/install.ps1 | iex

The following directories are used to search for logs in the file system:

• Program Files
• Program Files (x86)
• ProgramData
• AppData\Local and AppData\Roamin for current user

To read logs, automatic detection of the following encodings is supported:

• UTF-8
• UTF-16 with BOM
• UTF-16 without BOM
• Windows-1251 by default

Go Package

You can also use Go for install the dev version (Go must be installed in the system):

go install github.com/Lifailon/lazyjournal@latest

Usage

You can run the interface from anywhere:

lazyjournal                            Run interface
lazyjournal --help, -h                 Show help
lazyjournal --version, -v              Show version
lazyjournal --audit, -a                Show audit information
lazyjournal --tail, -t                 Change the number of log lines to output (default: 50000, range: 200-200000)
lazyjournal --update, -u               Change the auto refresh interval of the log output (default: 5, range: 2-10)
lazyjournal --disable-color, -d        Disable output coloring
lazyjournal --disable-timestamp, -s    Disable timestamp for docker logs
lazyjournal --command-color, -c        Coloring in command line mode
lazyjournal --command-fuzzy, -f        Filtering using fuzzy search in command line mode
lazyjournal --command-regex, -r        Filtering using regular expression (regexp) in command line mode

Access to all system logs and containers may require elevated privileges for the current user. For example, if a user does not have permission to access the /var/lib/docker/containers directory, they will not be able to access history data from the time the container was started, but only from the time the containerization system was started, so the process of reading logs is different.

Information in the subtitle of the Logs window:

• tail - maximum number of log lines to load.
• update - current output auto-update status (disabled when manually scrolling the output).
• interval - auto-update interval for output in seconds (file logs are updated only when there are changes).
• color - whether the output coloring mode is currently enabled or disabled.

Command-line mode

Coloring and filtering of output is supported in command-line mode:

alias lj=lazyjournal # >> $HOME/.bashrc

# Coloring the output from stdin
cat /var/log/syslog | lj -c

# Filtering output in fuzzy search and regular expression mode
cat /var/log/syslog | lj -f "error"
cat /var/log/syslog | lj -r "failed|fatal|crash"

Control

Mouse control is supported for window selection, history, list scrolling and history. To copy text, use Alt+Shift when selecting.

List of all used keyboard shortcuts:

• F1 - show help on hotkeys.
• Tab - switch between windows.
• Shift+Tab - return to previous window.
• Enter - selection a journal from the list to display log output.
• Left/Right - switch between journal lists in the selected window.
• <Up/PgUp> and <Down/PgDown> - move up and down through all journal lists and log output, as well as changing the filtering mode in the filter window.
• <Shift/Alt>+<Up/Down> - quickly move up and down through all journal lists and log output every 10 or 100 lines (500 for log output).
• <Shift/Ctrl>+<U/D> - quickly move up and down (alternative for macOS).
• Ctrl+A or Home - go to top of log.
• Ctrl+E or End - go to the end of the log.
• Alt+Left/Right - change the number of log lines to output (default: 50000, range: 200-200000).
• Shift+Left/Right - change the auto refresh interval of the log output (default: 5, range: 2-10).
• Ctrl+T - enable or disable timestamp for Docker logs.
• Ctrl+Q - enable or disable built-in output coloring.
• Ctrl+S - enable or disable coloring via tailspin.
• Ctrl+R - update all log lists.
• Ctrl+W - clear text input field for filter to quickly update current log output.
• Ctrl+C - exit.

Build

Clone the repository and run the project:

git clone https://github.com/Lifailon/lazyjournal
cd lazyjournal
go run main.go

Use make to build the binary for the current system and platform:

make build

Check the source code on the base linters using golangci-lint (including all critic and severity high in security):

make lint

Testing

Unit tests cover all main functions and interface operation.

# Get a list of all tests
make list
# Run selected or all tests
make test n=TestMockInterface
make test-all

The test coverage report using CI Actions for Linux, macOS and Windows systems is available on the Wiki page.

Testing in BSD-based systems is done in a home environment using usup.

Contributing

Since this is my first Go project, there may be some bad practices, BUT I want to make lazyjournal better. Any contribution will be appreciated! If you want to implement any new feature or fix something, please open an issue first.

Thanks to all participants for their contributions:

• Matteo Giordano for upload and update the package in AUR.
• Ueno M. for upload and update the package in Homebrew and Conda.

You can also upload the package yourself to any package manager you use and make Pull Requests.

Alternatives

• Lnav - The Logfile Navigator is a log file viewer for the terminal.
• TooLong - A terminal application to view, tail, merge, and search log files.
• Dozzle - A small lightweight application with a web based interface to monitor Docker logs.

If you like using TUI tools, try multranslate for translating text in multiple translators simultaneously and LLM, with support for translation history and automatic language detection.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Copyright (C) 2024 Lifailon (Alex Kup)