Quickstart

Get the CLI running in a Next.js App Router project and map routes fast.

Prerequisites

• Node.js 18+ (recommend matching your Next.js project requirement).
• Access to the project directory you want to scan.

Run the CLI

Launch the inspector UI

npx next-lens@latest web

List pages directly from the CLI

npx next-lens@latest page:list

Or filter API handlers by method

npx next-lens@latest api:list --method GET

Collect stack details

npx next-lens@latest info

Monorepo or alternate targets

All commands accept an optional [target-directory] (defaults to .):

npx next-lens@latest page:list ./apps/web

npx next-lens@latest api:list ../other-project --method POST

The CLI scans the provided directory without needing to run the Next.js development server.