Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 2.42 KB

README.md

File metadata and controls

71 lines (52 loc) · 2.42 KB

pino-minimal

A beautiful and minimal transport for pino

Header

Travis Build Status NPM version

Description

The pino-minimal transport provides a prettified, minimalistic and beautiful output for Pino.js. It's output format is strongly inspired by Signale.

Contents

Installation

NPM

$ npm install -g pino-minimal

Yarn

$ yarn global add pino-minimal

Usage

To use it, simply pipe the output from Pino into this transport. Example:

$ node server.js | pino-minimal

Command Line Arguments

This package supports several command line arguments to customize the output. A flag that is true by default can be negated by using it with a no prefix, e.g. to hide the time, use the option --no-time.

Option/s Type Default Description
--help, -h boolean - Show a help document.
--version, -v boolean - Show version information.
--date, -d boolean false Show a date in the log output.
--time, -t boolean true Show a time in the log output. Use --no-time to disable.
--pid, -p boolean false Show the process ID (PID) in the log output.
--hostname, -h boolean false Show the hostname in the log output.
--stacktrace, -s boolean true Show a stack trace for errors that occur. Use --no-stacktrace to disable.
--colorize, -c boolean Depends on terminal Colorize the console output. Use --no-colorize to disable.
--messageKey string msg The JSON key to read the message from.
--timestampKey string time The JSON key to read the timestamp from.
--crlf, -f boolean false Use CRLF line endings instead of LF line endings.

License

MIT