vConsole README

The project's README from github.com/Tencent/vConsole. As one markdown file: README.md.

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

For details, please see the screenshots below.


Release Notes

Latest version: npm 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:

$ npm install vconsole
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:

<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
<script>
  // VConsole will be exported to `window.VConsole` by default.
  var vConsole = new window.VConsole();
</script>

Available CDN:


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
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:

Custom Plugin:


Third-party Plugins


Feedback

QQ Group: 497430533


License

The MIT License

vConsole (Tencent/vConsole)

debugger
Searching Database…

17.5K ·GitHub
What is this?A lightweight, extendable front-end developer tool for debugging mobile web pages: an on-page console that shows logs, network requests, elements and storage right on the phone.
Is this a browser extension or code I add to my page?Code you add to your project, not an extension: it is framework-free, works in Vue, React or any other framework, and renders its console UI directly on the page.
How do I add it to a project?Two ways: npm install vconsole (recommended) and import it, or include a CDN script tag in your HTML.
Do I need anything special installed to use it?Nothing special: it is a normal npm package with small runtime deps (core-js, @babel/runtime, copy-text-to-clipboard) and no server component to run.
Is it only useful on mobile, or on desktop too?It is aimed at mobile web pages, where full devtools are unavailable; being regular script loaded with the page, it runs wherever that page runs.
Does it work in WeChat Miniprograms or just regular mobile pages?Both: it is now the official debugging tool for WeChat Miniprograms, and the repo ships a dedicated wx build alongside the regular web build.
Is it free to use, even commercially?Yes — it is released under the MIT License, so it is free to use and embed in any project, commercial included.
What can I actually inspect with it?Console logs (log, info, error and more), network requests from XMLHttpRequest, Fetch and sendBeacon, a realtime HTML element tree, system and performance info, plus a command line to execute JS manually.
Can I edit storage values from the panel?Yes — the Storage panel lets you add, edit, delete or copy Cookies, LocalStorage and SessionStorage entries.
Can I add my own panels or features?Yes, it supports custom plugins, with docs covering how to build one; the community maintains extras like vconsole-webpack-plugin, vite-plugin-vconsole and a vue-devtools plugin.
Does it have a dark mode?Yes — the overview screenshots show both light and dark themes.
Creator
Tencent
Size
5.1 MB
Stars
17.5K
Age
10y
Commits · 90 Days