PHPackages                             marc/epilog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. marc/epilog

ActiveLibrary[Logging & Monitoring](/categories/logging)

marc/epilog
===========

Epilog is a CLI log viewer with style

1.0.1(11y ago)34983↓50%[2 issues](https://github.com/marcioAlmada/epilog/issues)[1 PRs](https://github.com/marcioAlmada/epilog/pulls)MITPHP

Since Jan 10Pushed 10y ago4 watchersCompare

[ Source](https://github.com/marcioAlmada/epilog)[ Packagist](https://packagist.org/packages/marc/epilog)[ RSS](/packages/marc-epilog/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (7)Versions (5)Used By (0)

 [![Epilog](https://camo.githubusercontent.com/4333ee75f8b14154da15565591be8b1a63337823b76065c933a8f5ec2dc7b2af/68747470733a2f2f646c2e64726f70626f7875736572636f6e74656e742e636f6d2f752f34393534393533302f6570696c6f672f6570696c6f672d6c6f676f2e706e67)](https://camo.githubusercontent.com/4333ee75f8b14154da15565591be8b1a63337823b76065c933a8f5ec2dc7b2af/68747470733a2f2f646c2e64726f70626f7875736572636f6e74656e742e636f6d2f752f34393534393533302f6570696c6f672f6570696c6f672d6c6f676f2e706e67)
====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#--)

[![Build Status](https://camo.githubusercontent.com/85a4c098dc2ef0b35ba8df360eb6cf4fbdc668a231185182054de603ff5ec663/68747470733a2f2f7472617669732d63692e6f72672f6d617263696f416c6d6164612f6570696c6f672e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/marcioAlmada/epilog "Travis Build")[![Coverage Status](https://camo.githubusercontent.com/9d281e5ba2ea16e96d0a794761c6c0e7e6cf6eb4494661bae0f1cf7ec0142c21/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6d617263696f416c6d6164612f6570696c6f672f62616467652e706e673f6272616e63683d6d6173746572)](https://coveralls.io/r/marcioAlmada/epilog?branch=master "Code Coverage")[![Scrutinizer Quality Score](https://camo.githubusercontent.com/0a56af5618ee3f3c05e2dea7644176f842037175bef4dd94f6029853f8c70a8c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6d617263696f416c6d6164612f6570696c6f672f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/marcioAlmada/epilog/?branch=master "Code Quality")[![Latest Stable Version](https://camo.githubusercontent.com/eb713e9244290c8df71c21f41ba84bdf9f42768cf1de8bfce5fce5147ee37225/68747470733a2f2f706f7365722e707567782e6f72672f6d6172632f6570696c6f672f762f737461626c652e706e67)](https://packagist.org/packages/marc/epilog "Packagist")[![Total Downloads](https://camo.githubusercontent.com/a21c3ade66bf51c80385fc34ae2fb4041ebc7e7330b5684682d4d9f624d915ab/68747470733a2f2f706f7365722e707567782e6f72672f6d6172632f6570696c6f672f646f776e6c6f6164732e706e67)](https://packagist.org/packages/marc/epilog "Packagist")[![License](https://camo.githubusercontent.com/dcf34758510199afef8b7dd72646be0b60717601a28d5e977335b89f9f9f92bd/68747470733a2f2f706f7365722e707567782e6f72672f6d6172632f6570696c6f672f6c6963656e73652e706e67)](https://packagist.org/packages/marc/epilog "Packagist")[![SensioLabsInsight](https://camo.githubusercontent.com/247030f12c69164e4f68c2c4b5c57799dabd43df910e62bc68cb340a888dc9b7/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f30326431666430312d386137302d346665342d613535302d3338316133633065333366332f6d696e692e706e67)](https://insight.sensiolabs.com/projects/02d1fd01-8a70-4fe4-a550-381a3c0e33f3 "Sensiolabs Insight")

The lightweight, themeable and interactive PSR-3 log viewer. Monitor monologs with style:

[![asciinema](https://camo.githubusercontent.com/3aec4c9487a5c00cc1f4b4dd4aba7b6263676cbeed4890c840f846bdad3ed4fe/68747470733a2f2f646c2e64726f70626f7875736572636f6e74656e742e636f6d2f752f34393534393533302f6570696c6f672f61736369696e656d612e706e673f76312e30)](https://asciinema.org/a/12309?autoplay=true&speed=2)

Install
-------

[](#install)

As a composer project dependency:

```
{
    "require": {
        "marc/epilog": "~1.0"
    }
}
```

As a packed phar:

```
wget https://github.com/marcioAlmada/epilog/raw/master/bin/epilog && chmod +x epilog
mv epilog /usr/local/bin/ # or somewhere in your $PATH
```

As a composer global package:

```
composer global require marc/epilog:~1.0
```

Or build the phar yourself:

```
# install box2 -> https://github.com/box-project/box2
git clone https://github.com/marcioAlmada/epilog.git
cd epilog
composer install
make # phar will available at bin/ folder
sudo make install # will put epilog at /usr/local/bin/ folder
```

### Quick test

[](#quick-test)

Run **epilog** `pretend` command and tail a fake log stream. Check if output looks good:

```
epilog pretend
```

Usage
-----

[](#usage)

Basic usage is:

```
epilog watch /path/to/monolog/file.log []...
```

While epilog is monitoring the log file (or a fake stream), hit `[return]` to see a nice interactive menu:

```
$ [ ⏎ ]

Woot! Epilog here. Please type a theme number, a valid regexp or a valid flag:

[#] load another theme:

    1:chaplin       2:forest
    3:scrapbook     4:punchcard
    5:sunset        6:sunrise
    7:traffic       8:usa

[ r ] load random theme from list above.
[ i ] toggle invert theme.
[ c ] clear screen.
[ - ] reset regexp filter.
[ q ] quit.

```

Framework Integration
---------------------

[](#framework-integration)

Epilog can use [log finders](https://github.com/marcioAlmada/epilog/tree/master/src/LogFinder) to look for logs inside app directories according to framework conventions so you don't need to aim at your latest log files mannualy. Ex:

```
$ epilog watch ~/www/my-project --app laravel
# instead of long and boring
$ epilog watch ~/www/my-project/app/storage/logs/log-cli-server-2015-01-11.txt
```

> PRs implementing log finders to support your framework of choice are highly encouraged ![:octocat:](https://github.githubassets.com/images/icons/emoji/octocat.png ":octocat:")

Themes
------

[](#themes)

Epilog themes are very simple `yml` files with hooks where you can put ANSI color escape sequences and literal text. The hooks will decorate each log line, [nyancatyze](http://youtu.be/QH2-TGUlwu4) your terminal and sometimes [puke rainbows](http://youtu.be/-Cec2iAgW1Q). Here is a theme example:

```
name: Punched Card
author: Márcio Almada
theme:
    extends: default
    # the log line template
    # template tags are: {date}, {level}, {logger}, {message}, {context}, {extra}
    template: "{level} {date} {message} [{logger}] [{context}] [{extra}]"
    # literal string that will be prepended to entire line
    prepend: ""
    # literal string that will be appended to entire line
    append: "\e[0m\n"
    # level section
    level:
        padding: 10
        DEBUG:
            prepend: "        • \e[2m"
        INFO:
            prepend: "       •  \e[2m"
        NOTICE:
            prepend: "      •   \e[2m"
        WARNING:
            prepend: "     •    \e[2m"
        ERROR:
            prepend: "    •     \e[1m"
        CRITICAL:
            prepend: "   •      \e[1m"
        ALERT:
            prepend: "  •       \e[1m"
        EMERGENCY:
            prepend: " •        \e[1m"
        DEFAULT:
            prepend: " -------- \e[1m"
```

Which will make log lines look like the following, when interpreted:

[![punchcard theme](https://camo.githubusercontent.com/39936ca6516a364f6a9516546727039c4a10b6bddfdb570a594e03c8bbd4e614/68747470733a2f2f646c2e64726f70626f7875736572636f6e74656e742e636f6d2f752f34393534393533302f6570696c6f672f70756e6368636172642e706e67)](https://camo.githubusercontent.com/39936ca6516a364f6a9516546727039c4a10b6bddfdb570a594e03c8bbd4e614/68747470733a2f2f646c2e64726f70626f7875736572636f6e74656e742e636f6d2f752f34393534393533302f6570696c6f672f70756e6368636172642e706e67)

Roadmap
-------

[](#roadmap)

- Basic functionalities
- Add `--app` option to allow easy framework integration. Ex: `epilog watch /my/project --app laravel`
- Add `listen` command to aggregate log entries through a REST API. Ex: `epilog listen --port 8888`
- Add `server` command to view logs in a browser instead of terminal `epilog server  --port 8888`
- Add better unicode support, more themes etc
- Bother with windows ... anyone?
- Other cool things, probably
- Release stable version

Contributions
-------------

[](#contributions)

Found a bug? Have an improvement? Take a look at the [issues](https://github.com/marcioAlmada/epilog/issues).

### Guide

[](#guide)

1. Fork [marc/epilog](https://github.com/marcioAlmada/epilog/fork)
2. Clone forked repository
3. Install composer dependencies `$ composer install`
4. Run unit tests `$ phpunit`
5. Modify code: correct bug, implement features
6. Back to step 4

Copyright
---------

[](#copyright)

Copyright (c) 2014-2015 Márcio Almada. Distributed under the terms of an MIT-style license. See LICENSE for details.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 99% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~31 days

Total

5

Last Release

4023d ago

Major Versions

0.1.2 → 1.0.02015-04-22

### Community

Maintainers

![](https://www.gravatar.com/avatar/e6b4f6d6d37192719fb4d4d03bbdb9e866972a2b6556da9967b10b35843809f1?d=identicon)[marcioAlmada](/maintainers/marcioAlmada)

---

Top Contributors

[![marcioAlmada](https://avatars.githubusercontent.com/u/227395?v=4)](https://github.com/marcioAlmada "marcioAlmada (103 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")

---

Tags

logViewer

### Embed Badge

![Health badge](/badges/marc-epilog/health.svg)

```
[![Health](https://phpackages.com/badges/marc-epilog/health.svg)](https://phpackages.com/packages/marc-epilog)
```

###  Alternatives

[jackiedo/log-reader

An easy log reader and management tool for Laravel

151376.5k4](/packages/jackiedo-log-reader)[laravel-admin-ext/log-viewer

Log viewer for laravel

130323.4k7](/packages/laravel-admin-ext-log-viewer)[syonix/monolog-viewer

An easy-to-use viewer for log files generated by Monolog (https://github.com/Seldaek/monolog)

2756.1k](/packages/syonix-monolog-viewer)[kabbouchi/laravel-ward

25364.1k1](/packages/kabbouchi-laravel-ward)[achyutn/filament-log-viewer

A Filament package to view and manage Laravel logs.

4497.9k30](/packages/achyutn-filament-log-viewer)[yurizoom/moonshine-log-viewer

Log viewer for MoonShine

137.8k](/packages/yurizoom-moonshine-log-viewer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)