explaingit

klaudiosinani/signale

9,171JavaScriptAudience · developerComplexity · 2/5LicenseSetup · easy

TLDR

A Node.js logging library that adds colored icons, labels, and scope tags to terminal output, shipping with 19 built-in log types and support for custom types, timers, and sensitive value filtering.

Mindmap

mindmap
  root((signale))
    What it does
      Structured terminal logs
      Colored icons and labels
    Features
      19 built-in log types
      Custom log types
      Scoped logging
      Sensitive value filter
    Extras
      Built-in timers
      Interactive mode
      Multiple output streams
    Use Cases
      Node.js apps
      CLI tools
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Replace plain console.log calls in a Node.js app with structured, color-coded log types like success, error, warning, and debug.

USE CASE 2

Add scope labels to a large Node.js project so each module's log output is clearly tagged with its origin.

USE CASE 3

Filter sensitive values like API keys from appearing in terminal log output before they are printed.

USE CASE 4

Use built-in timers to measure how long async operations take and log the results in one call.

Tech stack

JavaScriptNode.jsnpmYarn

Getting it running

Difficulty · easy Time to first run · 5min
Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

In plain English

Signale is a logging library for Node.js that focuses on producing clean, readable output in the terminal. When a Node.js application writes log messages, they typically appear as plain text. Signale adds structure, color, icons, and labels to those messages, making it easier to scan what is happening at a glance. Out of the box, the library ships with 19 different log types covering the most common categories a developer needs: success, error, warning, information, debug, pending operations, and more. Each type has its own visual marker and color. You call them by name in your code, and the corresponding styled line appears in the terminal. Beyond the default set, you can define your own custom log types. You configure each type with a badge (an icon or symbol), a label, a color, and a log level. This lets you tailor the output to match exactly what your project needs. You can also override the appearance of the built-in types if the defaults do not fit your workflow. Signale supports scoping, which means you can tag messages with the name of the module or file they come from. This is useful in larger projects where multiple parts of the application are logging at the same time and you need to trace which message originated where. A few other features the README covers: built-in timers for measuring how long operations take, a mechanism to filter out sensitive values (like API keys or passwords) before they appear in logs, support for writing to multiple output streams at once, an interactive mode where terminal output updates in place rather than scrolling, and project-wide configuration through package.json. TypeScript types are included. The library is installable via npm or Yarn and is MIT-licensed.

Copy-paste prompts

Prompt 1
Using signale, replace my Node.js console.log calls with structured logs. Show me how to use success, error, warning, and pending types.
Prompt 2
How do I create a custom log type in signale with my own icon, label, and color for a specific workflow?
Prompt 3
Show me how to add scope labels in signale so each module in my Node.js app prints its name alongside every log message.
Prompt 4
I need to prevent API keys from appearing in my signale terminal output. How do I configure sensitive value filtering?
Open on GitHub → Explain another repo

← klaudiosinani on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.