NPM installation

The DataRamen CLI provides a lightweight local web application for exploring your database — no full self-hosted deployment required.

Prerequisites

• Node.js v22 or newer

Installation steps

Install the CLI globally with npm:

Terminal: install dataramen globally

npm install -g @dataramen/cli

You can verify the installation by running dataramen -v.

Run DataRamen

Once installed, start DataRamen with:

Terminal: start dataramen service

dataramen start

You can also use dtr alias, ex: dtr start.

Caution

Note that DataRamen CLI will not automatically restart on OS boot. You will have to run start command again manually.

Updating

To update the DataRamen CLI, re-run the install command and restart the tool. It will automatically apply any resource updates and run required migrations on the next start:

Terminal: update dataramen globally

npm install -g @dataramen/cli
dataramen start