Installation

Install Package

Add Nest Graph Inspector to your NestJS project.

npm install nest-graph-inspector

yarn add nest-graph-inspector

pnpm add nest-graph-inspector

bun add nest-graph-inspector

Install Module

Import NestGraphInspectorModule in your root module. By default, Nest Graph Inspector uses the Viewer output, so you get an interactive graph experience with no extra output configuration.

import { Module } from '@nestjs/common';
import { NestGraphInspectorModule } from 'nest-graph-inspector';

@Module({
  imports: [
    NestGraphInspectorModule // that's it!
  ],
})
export class AppModule {}

Run Project

npm run start

yarn start

pnpm start

bun run start

After startup, the inspector logs the Viewer URL and graph endpoint path in your console. Open the Viewer, enter your app origin, and inspect the live dependency graph.