cheerio

The fast, flexible, and elegant library for parsing and manipulating HTML and XML.

const cheerio = require('cheerio');
const $ = cheerio.load('<h2 class="title">Hello world</h2>');

$('h2.title').text('Hello there!');
$('h2').addClass('welcome');

$.html();
//=> <html><head></head><body><h2 class="title welcome">Hello there!</h2></body></html>

Installation

npm install cheerio

Features

❤ Proven syntax: Cheerio implements a subset of core jQuery. Cheerio removes all the DOM inconsistencies and browser cruft from the jQuery library, revealing its truly gorgeous API.

ϟ Blazingly fast: Cheerio works with a very simple, consistent DOM model. As a result parsing, manipulating, and rendering are incredibly efficient.

❁ Incredibly flexible: Cheerio wraps around parse5 for parsing HTML and can optionally use the forgiving htmlparser2. Cheerio can parse nearly any HTML or XML document. Cheerio works in both browser and server environments.

API

Loading

First you need to load in the HTML. This step in jQuery is implicit, since jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the HTML document.

// ES6 or TypeScript:
import * as cheerio from 'cheerio';

// In other environments:
const cheerio = require('cheerio');

const $ = cheerio.load('<ul id="fruits">...</ul>');

$.html();
//=> <html><head></head><body><ul id="fruits">...</ul></body></html>

Selectors

Once you've loaded the HTML, you can use jQuery-style selectors to find elements within the document.

$( selector, [context], [root] )

selector searches within the context scope which searches within the root scope. selector and context can be a string expression, DOM Element, array of DOM elements, or cheerio object. root, if provided, is typically the HTML document string.

This selector method is the starting point for traversing and manipulating the document. Like in jQuery, it's the primary method for selecting elements in the document.

$('.apple', '#fruits').text();
//=> Apple

$('ul .pear').attr('class');
//=> pear

$('li[class=orange]').html();
//=> Orange

Rendering

When you're ready to render the document, you can call the html method on the "root" selection:

$.root().html();
//=>  <html>
//      <head></head>
//      <body>
//        <ul id="fruits">
//          <li class="apple">Apple</li>
//          <li class="orange">Orange</li>
//          <li class="pear">Pear</li>
//        </ul>
//      </body>
//    </html>

If you want to render the outerHTML of a selection, you can use the outerHTML prop:

$('.pear').prop('outerHTML');
//=> <li class="pear">Pear</li>

You may also render the text content of a Cheerio object using the text method:

const $ = cheerio.load('This is <em>content</em>.');
$('body').text();
//=> This is content.

The "DOM Node" object

Cheerio collections are made up of objects that bear some resemblance to browser-based DOM nodes. You can expect them to define the following properties:

tagName
parentNode
previousSibling
nextSibling
nodeValue
firstChild
childNodes
lastChild

Screencasts

https://vimeo.com/31950192

This video tutorial is a follow-up to Nettut's "How to Scrape Web Pages with Node.js and jQuery", using cheerio instead of JSDOM + jQuery. This video shows how easy it is to use cheerio and how much faster cheerio is than JSDOM + jQuery.

Cheerio in the real world

Are you using cheerio in production? Add it to the wiki!

Backers

Become a backer to show your support for Cheerio and help us maintain and improve this open source project.

Special Thanks

This library stands on the shoulders of some incredible developers. A special thanks to:

• @fb55 for htmlparser2 & css-select: Felix has a knack for writing speedy parsing engines. He completely re-wrote both @tautologistic's node-htmlparser and @harry's node-soupselect from the ground up, making both of them much faster and more flexible. Cheerio would not be possible without his foundational work

• @jQuery team for jQuery: The core API is the best of its class and despite dealing with all the browser inconsistencies the code base is extremely clean and easy to follow. Much of cheerio's implementation and documentation is from jQuery. Thanks guys.

• @tj: The style, the structure, the open-source"-ness" of this library comes from studying TJ's style and using many of his libraries. This dude consistently pumps out high-quality libraries and has always been more than willing to help or answer questions. You rock TJ.

License

MIT

Project Name	Stars	Repos Using This	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Htmlparser2	3,907	339,787	1,872	3 days ago	76	April 29, 2022	2	mit	TypeScript
The fast & forgiving HTML and XML parser
Posthtml	2,879	8,908	431	4 days ago	53	February 25, 2022	13	mit	JavaScript
PostHTML is a tool to transform HTML/XML with JS plugins
Hpple	2,744	349		5 years ago	3	March 24, 2015	39	mit	Objective-C
An XML/HTML parser for Objective-C, inspired by Hpricot.
Kanna	2,204	328		2 years ago	30	August 07, 2021	15	mit	Swift
Kanna(鉋) is an XML/HTML parser for Swift.
Didom	2,068	106	56	3 months ago	59	July 27, 2021	7	mit	PHP
Simple and fast HTML and XML parser
Oga	1,153			3 months ago				mpl-2.0	Ruby
Oga is an XML/HTML parser written in Ruby.
Fuzi	1,018	63		22 days ago	18	December 13, 2020	20	mit	Swift
A fast & lightweight XML & HTML parser in Swift with XPath & CSS support
Ji	819	81		3 years ago	10	October 17, 2017	8	mit	Swift
Ji (戟) is an XML/HTML parser for Swift
Hquery.php	331	1	2	4 months ago	23	July 19, 2019	15	mit	PHP
An extremely fast web scraper that parses megabytes of invalid HTML in a blink of an eye. PHP5.3+, no dependencies.
Clj Tagsoup	157			3 years ago	3	January 12, 2021	11	other	Clojure
A HTML parser for Clojure.

Cheerio