Monthly Downloads: 0
Programming language: TypeScript
License: GNU General Public License v3.0 or later
Tags: Logging    
Latest version: v2.15.3

consola alternatives and similar modules

Based on the "Logging" category.
Alternatively, view consola alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of consola or a related project?

Add another 'Logging' Module




Elegant Console Logger for Node.js and Browser

Standard JS npm version npm downloads package phobia bundle phobia

Why Consola?

๐Ÿ‘Œ  Easy to use ๐Ÿ’…  Fancy output with fallback for minimal environments ๐Ÿ”Œ  Pluggable reporters ๐Ÿ’ป  Consistent command line interface (CLI) experience ๐Ÿท  Tag support ๐Ÿš  Redirect console and stdout/stderr to consola and easily restore redirect. ๐ŸŒ  Browser support โฏ  Pause/Resume support ๐Ÿ‘ป  Mocking support ๐Ÿ‘ฎโ€โ™‚๏ธ  Spam prevention by throttling logs


Using yarn:

yarn add consola

Using npm:

npm i consola

Getting Started

const consola = require('consola')

// See types section for all available types

consola.info('Reporter: Some info')
consola.error(new Error('Foo'))

Will display in the terminal:

Screenshot 2020-01-28 at 14 15 15

NOTE: Alternatively, you can import consola from source. But don't forget to whitelist it for transpilation:

import consola from 'consola/src/node'
import consola from 'consola/src/browser'


<type>(logObject) <type>(args...)

Log to all reporters.

Example: consola.info('Message')

A list of available types can be found [here](./src/types.js).


  • Aliases: add

Register a custom reporter instance.


  • Aliases: remove, clear

Remove a registered reporter.

If no arguments are passed all reporters will be removed.


Replace all reporters.


Create a new Consola instance and inherit all parent options for defaults.


Create a new Consola instance with provided defaults


  • Aliases: withScope

Create a new Consola instance with that tag.

wrapConsole() restoreConsole()

Globally redirect all console.log, etc calls to consola handlers.

wrapStd() restoreStd()

Globally redirect all stdout/stderr outputs to consola.

wrapAll() restoreAll()

Wrap both, std and console.

console uses std in the underlying so calling wrapStd redirects console too. Benefit of this function is that things like console.info will be correctly redirected to the corresponding type.

pauseLogs() resumeLogs()

  • Aliases: pause/resume

Globally pause and resume logs.

Consola will enqueue all logs when paused and then sends them to the reported when resumed.


  • Aliases: mock

Mock all types. Useful for using with tests.

The first argument passed to mockTypes should be a callback function accepting (typeName, type) and returning the mocked value:

consola.mockTypes((typeName, type) => jest.fn())

Please note that with the example above, everything is mocked independently for each type. If you need one mocked fn create it outside:

const fn = jest.fn()
consola.mockTypes(() => fn)

If callback function returns a falsy value, that type won't be mocked.

For example if you just need to mock consola.fatal:

consola.mockTypes((typeName) => typeName === 'fatal' && jest.fn())

NOTE: Any instance of consola that inherits the mocked instance, will apply provided callback again. This way, mocking works for withTag scoped loggers without need to extra efforts.



An array of active reporters.


The level to display logs. Any logs at or above this level will be displayed. List of available levels [here](./src/types.js).

You can set the log level using the CONSOLA_LEVEL environment variable, which must have the numeric log level as its value.


The logObject is a free-to-extend object which will be passed to reporters.

Standard fields:

  • message
  • additional
  • args
  • date
  • tag

Extra fields:

  • badge


Choose between one of the built-in reporters or bring in your own one.

By default FancyReporter is registered for modern terminals or BasicReporter will be used if running in limited environments such as CIs.

Available reporters:

  • [BasicReporter](./src/reporters/basic.js)
  • [FancyReporter](./src/reporters/fancy.js)
  • [JSONReporter](./src/reporters/json.js)
  • [WinstonReporter](./src/reporters/winston.js)

Creating your own reporter

A reporter (class or object) exposes log(logObj) method. To get more info about how to write your own reporter, take a look into the linked implementations above.


Types are used to actually log messages to the reporters. Each type is attached to a logging level.

A list of all available default types is [here](./src/types.js).

Creating a new instance

Consola has a global instance and is recommended to use everywhere. In case more control is needed, create a new instance.

import consola from 'consola'

const logger = consola.create({
    // level: 4,
    reporters: [
      new consola.JSONReporter()
    defaults: {
      additionalColor: 'white'


With jest

describe('your-consola-mock-test', () => {
  beforeAll(() => {
    // Redirect std and console to consola too
    // Calling this once is sufficient

  beforeEach(() => {
    // Re-mock consola before each test call to remove
    // calls from before
    consola.mockTypes(() => jest.fn())

  test('your test', async () => {
    // Some code here

    // Let's retrieve all messages of `consola.log`
    // Get the mock and map all calls to their first argument
    const consolaMessages = consola.log.mock.calls.map(c => c[0])
    expect(consolaMessages).toContain('your message')


With jsdom

  virtualConsole: new jsdom.VirtualConsole().sendTo(consola)


MIT - Made with ๐Ÿ’– By Nuxt.js team!

<!-- Refs -->

*Note that all licence references and agreements mentioned in the consola README section above are relevant to that project's source code only.