shepai

A zero-config log viewer for files and Docker, streamed live in your browser.

Website · Report Bug · Request Feature

shepai (সেপাই) is a zero-config, real‑time log viewer with JSON support that streams logs directly to your browser.

It supports both application log files and Docker container logs, runs entirely locally, and exposes a clean web dashboard at http://localhost:4040.

Motivation

I built shepai because I genuinely dislike debugging logs in the terminal.

Modern application logs are no longer simple strings — they're often deeply nested JSON, long stack traces, or structured logs that wrap across multiple lines. In a terminal, this quickly becomes painful.

I wanted a way to see logs the way they deserve to be seen — structured, searchable, expandable, and persistent on screen — without introducing heavy log infrastructure or changing application code.

shepai is the result: a local, zero-config log viewer that turns raw logs into something you can actually reason about.

Features

• Zero configuration for common dev workflows
• Real-time log streaming
• JSON viewer with syntax highlighting and collapsible structure
• Expandable stack traces viewer
• Severity highlighting with color-coded log levels
• Log Severity Filtering - Filter logs by level (Error, Warning, Info, Debug, etc.)
• Focus Mode - Click a log entry to focus on it while blurring others
• powerful Search - Real-time text filtering and highlighting
• Zoom Controls - Adjust text size for better readability
• Dark/Light Mode - Toggle between themes
• ANSI color support - Preserves colors from logs
• Automatic reconnection when containers restart or files are deleted/recreated
• No dependency on application code changes
• No shelling out to system commands for log streaming
• Cross-platform support (macOS, Linux, Windows)

preview.mp4

Getting Started

Installation

Choose the installation method for your operating system:

macOS & Linux

curl -fsSL https://raw.githubusercontent.com/arifszn/shepai/main/install.sh | bash

Verify the installation:

shepai --version

---

Windows

Option 1: PowerShell Script (Recommended)

irm https://raw.githubusercontent.com/arifszn/shepai/main/install.ps1 | iex

Verify the installation (restart your terminal first):

shepai --version

Option 2: Manual Installation

If you prefer to install manually:

1. Download the shepai-windows-amd64.zip asset from the latest release
2. Extract the archive to your preferred location
3. Open a terminal in the extracted directory

Verify the installation:

.\shepai.exe --version

Note for Option 2: For system-wide access, add the extracted directory to your PATH environment variable.

Usage

File Logs

shepai file storage/logs/laravel.log

Docker Container Logs

shepai docker my_container

Options

• --port <number> — Port for the web dashboard (default: 4040)

shepai docker my_container --port 8080

Uninstallation

If you need to remove shepai from your system:

macOS & Linux

curl -fsSL https://raw.githubusercontent.com/arifszn/shepai/main/uninstall.sh | bash

---

Windows

irm https://raw.githubusercontent.com/arifszn/shepai/main/uninstall.ps1 | iex

Development

See CONTRIBUTING.md for detailed development setup and guidelines.

License

MIT