Skip to content

Quick Start Guide

nview is a local monitoring tool for a Cardano Node (cardano-node) meant to complement remote monitoring tools by providing a local view of a running node from the command line. It is a TUI (terminal user interface) designed to fit most screens.

Simply download the nview binary file from blinklabs.io on to your node server. Then run nview in the server command line. It’s that simple to use and you will get monitoring right out of the box!

To get started follow the steps below



Step 1-A - First start by going to https://blinklabs.io/projects-open-source and scroll down to nview.

nview-blinklabs-site

Step 1-B - Select the operating system of your node server.

nview-blinklabs-site-operating-system

Step 1-C - You can either download the binary file and move the file to your node server or…

nview-blinklabs-site-download


Copy the path from Blinklabs and run the following command to download the binary file on your node server

nview-blinklabs-site-copy-link

⚠️ Adjust the link path to the correct path for the version you want to download.

wget -cO - https://github.com/blinklabs-io/nview/releases/download/v0.10.7/nview-v0.10.7-linux-amd64 > nview

For this example, we named the binary file nview and saved the file to our $NODE_HOME folder. To make the file executable run the following command:

⚠️ Adjust the file path and file name if needed.

chmod +x $NODE_HOME/nview

Run the executable file by running the following command.

⚠️ For this example, we named the binary file nview and saved the file to our $NODE_HOME folder.

cd $NODE_HOME
./nview

nview-screen


Congratulations you are ready to start monitoring your node using nview!

Section titled “Congratulations you are ready to start monitoring your node using nview!”

Running nview against a running Cardano Node will work out of the box with a default Cardano Node configuration. However, if you need to make change you can run nview with a configuration file.

Do you want to adjust the configuration file of nview? See our how to use a configuration file guide for nview.