Tencent /vConsole

A lightweight, extendable front-end developer tool for mobile web page.

★ 17,540⑂ 2,959👁 301⑃ 224● 507▤ 57
TypeScriptNOASSERTIONCreated 2016-04-27
Download: v3.15.1v3.15.1 ↓3.15.12023-06-01
+0
Daily
17,540
stars
2,959
forks
301
watchers
224
prs
507
issues
57
releases

README

English | 简体中文

vConsole
===

A lightweight, extendable front-end developer tool for mobile web page.

vConsole is framework-free, you can use it in Vue or React or any other framework application.

Now vConsole is the official debugging tool for WeChat Miniprograms.

---

 Features

- Logs: console.log|info|error|...
- Network: XMLHttpRequest, Fetch, sendBeacon
- Element: HTML elements tree
- Storage: Cookies, LocalStorage, SessionStorage
- Execute JS command manually
- Custom plugins

For details, please see the screenshots below.

---

 Release Notes

Latest version: 

Detailed release notes for each version are available on Changelog.

---

 Guide

See Tutorial for more usage details.

For installation, there are 2 primary ways of adding vConsole to a project:

 Method 1: Using npm (Recommended)

bash
$ npm install vconsole


javascript
import VConsole from 'vconsole';

const vConsole = new VConsole();
// or init with options
const vConsole = new VConsole({ theme: 'dark' });

// call console methods as usual
console.log('Hello world');

// remove it when you finish debugging
vConsole.destroy();


 Method 2: Using CDN in HTML:

html


  // VConsole will be exported to window.VConsole by default.
  var vConsole = new window.VConsole();



Available CDN:

- https://unpkg.com/vconsole@latest/dist/vconsole.min.js
- https://cdn.jsdelivr.net/npm/vconsole@latest/dist/vconsole.min.js

---

 Preview

http://wechatfe.github.io/vconsole/demo.html

!

---

 Screenshots

 Overview


  Light theme

!



  Dark theme

!


 Log Panel


  Log styling

!



  Command line

!


 System Panel


  Performance info

!



  Output logs to different panel

javascript
console.log('output to Log panel.')
console.log('[system]', 'output to System panel.')



 Network Panel


  Request details

!


 Element Panel


  Realtime HTML elements structure

!


 Storage Panel


  Add, edit, delete or copy Cookies / LocalStorage / SessionStorage

!


---

 Documentation

vConsole:

 - Tutorial
 - Public Properties & Methods
 - Builtin Plugin: Properties & Methods

Custom Plugin:

 - Plugin: Getting Started
 - Plugin: Building a Plugin
 - Plugin: Event List

---

 Third-party Plugins

 - vConsole-sources
 - vconsole-webpack-plugin
 - vconsole-stats-plugin
 - vconsole-vue-devtools-plugin
 - vconsole-outputlog-plugin
 - vite-plugin-vconsole

---

 Feedback

QQ Group: 497430533

!

---

 License

The MIT License

Top issues

Latest release

v3.15.1 v3.15.1 2023-06-01
EN:

- Feat(Netwrk) Add new option network.ignoreUrlRegExp to skip some requests. (PR 623)
- Fix(Core) Fix prototype pollution in vConsole.setOption(). (issue 616 621)
- Fix(Core) Fix plugin event ready triggering before its HTML finishes rendering. (issue 591)
- Fix(Log) Reset group state when console.clear() is called. (issue 611)
- Fix(Log) Compatible with iOS (less than 13.4) that does not support ResizeObserver, but there may be a potential performance issue when printing a large number of logs. (issue 610)
- Fix(Network) Fix possible "Cannot read property" error by sendBeacon. (is

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON