Nodejs Dashboard

Telemetry dashboard for node.js apps from the terminal!
Alternatives To Nodejs Dashboard
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
2 days ago381mitC
GoAccess is a real-time web log analyzer and interactive viewer that runs in a terminal in *nix systems or through your browser.
Wtf15,0171a month ago99February 24, 202343mpl-2.0Go
The personal information dashboard for your terminal
Webpack Dashboard13,8892,8801,0854 months ago50May 18, 202338mitJavaScript
A CLI dashboard for webpack dev server
Termui12,60519200a month ago3January 24, 2021100mitGo
Golang terminal dashboard
Tui Rs10,834764552 months ago37August 14, 2022mitRust
Build terminal user interfaces and dashboards using Rust
Gtop9,47432a month ago15January 12, 202239mitJavaScript
System monitoring dashboard for terminal
Gdb Dashboard9,265
5 months ago10mitPython
Modular visual interface for GDB in Python
Tiny Care Terminal5,94814 months ago25May 01, 202035mitJavaScript
💖💻 A little dashboard that tries to take care of you when you're using your terminal.
Awesome Tuis5,270
a day ago5
List of projects that provide terminal user interfaces
Nodejs Dashboard3,94170292 years ago12November 22, 201915mitJavaScript
Telemetry dashboard for node.js apps from the terminal!
Alternatives To Nodejs Dashboard
Select To Compare

Alternative Project Comparisons


Telemetry dashboard for node.js apps from the terminal!

Build Status

Determine in realtime what's happening inside your node process from the terminal. No need to instrument code to get the deets. Also splits stderr/stdout to help spot errors sooner.

Install Setup Usage Using with other programs CLI options Customizing layouts

NOTE: This module isn't designed for production use and should be limited to development environments.


The preferred method is global install. npm install -g nodejs-dashboard

Local install works also; just use ./node_modules/.bin/nodejs-dashboard instead of nodejs-dashboard to execute.


The dashboard agent needs to be required by your app. There are two ways to do this:

Including via code

From within a dev.index.js script or other dev entry point simply require the nodejs-dashboard module.

// dev.index.js

To launch: nodejs-dashboard node dev.index.js

Including via preload argument

This method utilizes Node's -r flag to introduce the nodejs-dashboard module. In this setup no code modifications are required. This is functionally equivalent to the above example.

To launch: nodejs-dashboard -- node -r nodejs-dashboard index.js


nodejs-dashboard uses the Braille Unicode character set to show graphs via the node-drawille dependancy. Ensure your terminal program's font supports this character set.

Environment variables

nodejs-dashboard uses several environment variables to modify its behavior. These include some required values to prevent mangled output.

Variable Required Source Description
TERM required blessed Terminal value matching terminal program
LANG required blessed Matches encoding of terminal program to display font correctly
FORCE_COLOR optional chalk Used to force color output by the subprocess


Press ? to see a list of keybindings. Use arrow keys to change the layout.

You may want to add an npm script to to your package.json to launch your app using nodejs-dashboard using one of the options above. Example:

"scripts": {
  "dev": "nodejs-dashboard -- node -r nodejs-dashboard index.js"

Passing arguments

If your app requires additional arguments you'll need to use the -- flag to separate them from nodejs-dashboard options. For example:

nodejs-dashboard --port=8002 -- node -m=false --bar=true index.js

Launching your app with something other than node

Most CLI interfaces provide a mechanism for launching other tools. If you're looking to use something like nodemon or babel checkout the exec options provided by the CLI.

% nodemon --exec "nodejs-dashboard babel-node" src/index.js

Docker and Docker Compose support

nodejs-dashboard can run inside a container if that container has a TTY allocated to it. The Docker documentation shows how to run a container with an interactive terminal session. Additional the Docker Compose documentation indicates that docker-compose run defaults to allocating a TTY and docker-compose up defaults to not allocating one.

CLI options

Usage: nodejs-dashboard [options] -- [node] [script] [arguments]

  -h, --help                  output usage information
  -e, --eventdelay [ms]       Minimum threshold for event loop reporting, default 10ms
  -l, --layouts [file]        Path to file or npm module with layouts
  -p, --port [port]           Socket listener port
  -r, --refreshinterval [ms]  Metrics refresh interval, default 1000ms
  -s, --settings [settings]   Overrides layout settings for given view types           
  -V, --version               output the version number

This tunes the minimum threshold for reporting event loop delays. The default value is 10ms. Any delay below this value will be reported at 0.


Optionally supply a custom layout configuration (for details, see Customizing Layouts). Default: lib/default-layout-config.js


Under the hood the dashboard utilizes SocketIO with a default port of 9838. If this conflicts with an existing service you can optionally change this value.


Specifies the interval in milliseconds that the metrics should be refreshed. The default is 1000 ms (1 second).


Overrides default or layout settings for views. Option value settings should have a format <view_type.setting.path>=<value>,.... For example --settings log.scrollback=100 will override scrollback setting for any view of log type (nested paths can be used if needed). For details about layouts, see Customizing Layouts).

Maintenance Status

Archived: This project is no longer maintained by Formidable. We are no longer responding to issues or pull requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!

Popular Terminal Projects
Popular Dashboard Projects
Popular Command Line Interface Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.