About debug
A usage guide for the debug package in LobeHub projects. It covers module-based namespaces, log formatting, and ways to enable debug output in browser, Node.js, and Electron environments.
Key features
- 01Module-based namespace conventions
- 02Object and number format specifiers
- 03Enable output in the browser
- 04Enable logs with Node.js environment variables
- 05Electron configuration example
Use cases
- 01Filter logs by server or client module
- 02Inspect logged object data while debugging
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ lobehub/ lobehub --skill debugAfter installing, type/debugin Claude Code to confirm it loaded.
Details
From the project READMEDebug Package Usage Guide
Basic Usage
import debug from 'debug';
// Format: lobe-[module]:[submodule]
const log = debug('lobe-server:market');
log('Simple message');
log('With variable: %O', object);
log('Formatted number: %d', number);
Namespace Conventions
- Desktop:
lobe-desktop:[module] - Server:
lobe-server:[module] - Client:
lobe-client:[module] - Router:
lobe-[type]-router:[module]
Format Specifiers
%O- Object expanded (recommended for complex objects)%o- Object%s- String%d- Number
Enable Debug Output
Browser
localStorage.debug = 'lobe-*';
Node.js
DEBUG=lobe-* npm run dev
DEBUG=lobe-* pnpm dev
Electron
process.env.DEBUG = 'lobe-*';
Example
// src/server/routers/edge/market/index.ts
import debug from 'debug';
const log = debug('lobe-edge-router:market');
log('getAgent input: %O', input);
Comments
Markdown supported