Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pouryazardosht/nestjs-devtools/llms.txt

Use this file to discover all available pages before exploring further.

In the next five minutes you will insert your first smart logger statement and open the module file picker — the two core workflows that NestJS DevTools is built around. No configuration needed; everything works out of the box the moment the extension is installed.

​
Part 1: Insert a logger statement

1

Open a NestJS TypeScript file

Open any TypeScript file that contains a class — for example, user.service.ts. Make sure VS Code has the file focused in the active editor.
2

Select a variable or expression

Place the cursor on a line with a variable you want to log, then select that variable. For example, on this line:
const user = await this.userRepository.findOne({
  where: { email },
});
Select the word user on the const user line.
3

Press the debug log chord

Press Cmd+L Cmd+D on macOS or Ctrl+L Ctrl+D on Windows/Linux to insert a debug log statement.Because the selected line ends with { (opening a multi-line object argument), NestJS DevTools traces the closing } on the third line and inserts the log after that closing brace — never inside the block:
const user = await this.userRepository.findOne({
  where: { email },
});
this.logger.debug("🔍 UserService ~ user", user);
UserService was detected automatically. The extension scanned upward from the cursor and found the enclosing class UserService declaration — no manual input required.
4

Confirm in the status bar

The VS Code status bar briefly displays ✅ Logger.debug inserted for three seconds to confirm the operation succeeded.
The same workflow applies to all five log levels. Use the chord that matches the severity you need:
MethodmacOSWindows/LinuxEmoji
debugCmd+L Cmd+DCtrl+L Ctrl+D🔍
logCmd+L Cmd+LCtrl+L Ctrl+L📝
warnCmd+L Cmd+WCtrl+L Ctrl+W⚠️
errorCmd+L Cmd+ECtrl+L Ctrl+E❌
verboseCmd+L Cmd+VCtrl+L Ctrl+V🔊

​
Part 2: Navigate module files

1

Open any file inside a module

Navigate to any .ts file that lives inside a NestJS module folder — even a deeply nested one, such as src/auth/dto/create-user.dto.ts. You do not need to be in the module root; the extension will walk up the directory tree to find the nearest *.module.ts.Press Cmd+L Cmd+K on macOS or Ctrl+L Ctrl+K on Windows/Linux to trigger Search Module Files.
2

Browse the grouped quick-pick

A quick-pick panel appears listing every .ts file found under the module root, organised into named category sections:
  • Core NestJS — services, controllers, modules, guards, gateways, interceptors, pipes, filters, resolvers, decorators
  • Entities
  • DTOs
  • Enums
  • Interfaces
  • Other — repositories, middleware, strategies, test specs
  • Other Files — any .ts files that do not match a known NestJS suffix
Each entry shows its emoji, file name, type label, shortcut letter, and relative path.
3

Type a shortcut letter to open instantly

Type the shortcut letter for the file type you want. The file opens the moment your input matches a known shortcut — no Enter required:
ShortcutFile type
sService
cController
mModule
gGuard
gwGateway
iInterceptor
pPipe
fFilter
rResolver
dDecorator
eEntity
dtDTO
enEnum
ifInterface
rpRepository
mwMiddleware
stStrategy
tTest (spec)
You can also scroll the list manually and press Enter to open any highlighted file.

​
Browse from the module picker

If you want to navigate to a module other than the one containing your current file, use the Open Module Files command instead:
  1. Press Cmd+L Cmd+M (macOS) or Ctrl+L Ctrl+M (Windows/Linux).
  2. A picker lists every *.module.ts file found in your workspace, sorted alphabetically.
  3. Select a module — the same grouped file picker appears for that module, ready for a shortcut-letter jump.

​
Next steps

Logger Helper deep-dive

Explore all five log levels, learn how class-name detection works, and see how indentation and block-end insertion are handled.

Module File Searcher deep-dive

Understand the full file-categorisation system, the directory-walking algorithm, and the complete shortcut-letter reference.

Full command reference

Every command ID, its default keyboard binding, and the when clause that controls when it is active.

Keyboard shortcuts

A printable reference for all chords on both macOS and Windows/Linux, plus instructions for customising them.

Build docs developers (and LLMs) love

Get started for freeTalk to us