cheerio README

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

cheerio

The fast, flexible, and elegant library for parsing and manipulating HTML and XML.
Build Status Coverage OpenCollective backers OpenCollective sponsors OpenSSF Scorecard

中文文档 (Chinese Readme)

import * as cheerio from '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

Install Cheerio using a package manager like npm, yarn, bun, or Deno.

npm install cheerio
# or
bun add cheerio
# or
deno 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.

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

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!

Sponsors

Does your company use Cheerio in production? Please consider sponsoring this project! Your help will allow maintainers to dedicate more time and resources to its development and support.

Headlining Sponsors

ScrapingBee Github AirBnB

Other Sponsors

OnlineCasinosSpelen Nieuwe-Casinos.net Rapidproxy

Backers

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

Vasy Kafidoff

License

MIT

cheerio (cheeriojs/cheerio)

parser
Searching Database…

30.5K ·GitHub
Cheerio
What is this?Cheerio is a fast, flexible library for parsing and manipulating HTML and XML. It implements a subset of the core jQuery API, so if you know jQuery selectors you already know most of it.
Is it basically jQuery, or something different?It's a JavaScript library that implements a subset of core jQuery, but strips out DOM inconsistencies and browser cruft. Unlike jQuery, it has no baked-in page DOM — you load the HTML you want to work on yourself.
How do I add it to a project?Install it with any JavaScript package manager — npm, yarn, bun, or Deno (npm install cheerio). Then load in an HTML string, find elements with jQuery-style selectors, and render results with html() or text().
Which Node version does it need, and is there anything else to set up?The package declares Node >= 22.19.0, which is fairly recent — check your runtime first. Nothing else is needed: parsing engines ship as bundled dependencies.
Will it handle messy real-world HTML and XML?Yes — it can parse nearly any HTML or XML document. It wraps parse5 for HTML by default and can optionally use the more forgiving htmlparser2, so broken markup won't stop it.
Does it run only under Node, or in the browser too?Both — the README says it works in browser and server environments. Since it's pure TypeScript/JavaScript with no native code, there are no OS requirements.
After I select and modify elements, how do I get the result back out?Call html() on the root selection to render the document, read the outerHTML prop to get a selection's outer HTML, or use text() when you only want the text content.
How flexible is the selector call?The primary $(selector, context, root) method searches within the context scope, which searches within the root scope. Selector and context can be a string expression, a DOM element, an array of DOM elements, or a Cheerio object.
Why use it for web scraping instead of JSDOM plus jQuery?The README's own screencast shows how much faster Cheerio is than JSDOM + jQuery: its simple, consistent DOM model makes parsing, manipulating, and rendering incredibly efficient.
Do selected elements behave like real DOM nodes?They bear a strong resemblance to browser-based DOM nodes — you can expect familiar properties such as tagName, parentNode, previousSibling, nextSibling, firstChild, and childNodes on them.
What are similar projects?goquery, marked, jquery, turndown, masonry, jsoup, jsdom, velocity
Which topics is it in?xml, jquery, parsing, scraper, scraping, dom, parser, web-scraping, javascript-library, browser, hacktoberfest, html
Creator
cheeriojs
Size
21.7 MB
Stars
30.5K
Updated
CommitOct 16Releasev1.2.0Jan 23
Age
15y
Commits · 90 Days