https://github.com/arifszn/shepai
A zero-config log viewer for files and Docker, streamed live in your browser
https://github.com/arifszn/shepai
cli devtools docker log log-streaming log-streaming-cli log-streaming-web-client logging logviewer monitoring monitoring-tool observability realtime
Last synced: 5 months ago
JSON representation
A zero-config log viewer for files and Docker, streamed live in your browser
- Host: GitHub
- URL: https://github.com/arifszn/shepai
- Owner: arifszn
- License: mit
- Created: 2025-12-24T14:15:51.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-12T15:57:42.000Z (5 months ago)
- Last Synced: 2026-01-12T21:43:05.275Z (5 months ago)
- Topics: cli, devtools, docker, log, log-streaming, log-streaming-cli, log-streaming-web-client, logging, logviewer, monitoring, monitoring-tool, observability, realtime
- Language: TypeScript
- Homepage: https://arifszn.github.io/shepai
- Size: 10.3 MB
- Stars: 10
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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)
https://github.com/user-attachments/assets/9118aa6b-5d5c-41bc-80e4-ae1b064e09a2
## Getting Started
### Installation
Choose the installation method for your operating system:
#### macOS & Linux
```bash
curl -fsSL https://raw.githubusercontent.com/arifszn/shepai/main/install.sh | bash
```
**Verify the installation:**
```bash
shepai --version
```
---
#### Windows
##### Option 1: PowerShell Script (Recommended)
```powershell
irm https://raw.githubusercontent.com/arifszn/shepai/main/install.ps1 | iex
```
**Verify the installation** (restart your terminal first):
```powershell
shepai --version
```
##### Option 2: Manual Installation
If you prefer to install manually:
1. Download the `shepai-windows-amd64.zip` asset from the [**latest release**](https://github.com/arifszn/shepai/releases/latest)
2. Extract the archive to your preferred location
3. Open a terminal in the extracted directory
**Verify the installation:**
```powershell
.\shepai.exe --version
```
> **Note for Option 2:** For system-wide access, add the extracted directory to your PATH environment variable.
### Usage
#### File Logs
```bash
shepai file storage/logs/laravel.log
```
#### Docker Container Logs
```bash
shepai docker my_container
```
### Options
- `--port ` — Port for the web dashboard (default: 4040)
```bash
shepai docker my_container --port 8080
```
### Uninstallation
If you need to remove shepai from your system:
#### macOS & Linux
```bash
curl -fsSL https://raw.githubusercontent.com/arifszn/shepai/main/uninstall.sh | bash
```
---
#### Windows
```powershell
irm https://raw.githubusercontent.com/arifszn/shepai/main/uninstall.ps1 | iex
```
## Development
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development setup and guidelines.
## License
[MIT](LICENSE)