Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.
TypeScript apifyautomationcrawlercrawlingheadlessheadless-chromejavascriptnodejsnpmplaywrightpuppeteerscraperscrapingtypescriptweb-crawlerweb-crawlingweb-scraping
Add live view documentation
Ondra Urbanfb1936a70a0c
diff --git a/README.md b/README.mdindex e414048a8..fe8619239 100644--- a/README.md+++ b/README.md@@ -34,6 +34,7 @@ Complete documentation of this package is available at https://www.apify.com/doc+ [Puppeteer Crawler](#puppeteer-crawler)+ [Request List](#request-list)+ [Puppeteer Pool](#puppeteer-pool)+ + [Puppeteer Live View](#puppeteer-live-view)- [Local usage](#local-usage)- [Promises vs. callbacks](#promises-vs-callbacks)- [Examples](#examples)@@ -345,6 +346,33 @@ For more information see complete <a href="https://www.apify.com/docs/sdk/apify-<div id="include-readme-3">+#### Puppeteer Live View++Enables real time inspection of individual Puppeteer browser instances. This is especially useful when using headless mode or a remote instance.+Puppeteer Live View provides the user with a dashboard listing all active browser instances and their active page details. The details show a page screenshot and raw HTML.++You can use Puppeteer Live View, either directly:+```javascript+const browser = Apify.launchPuppeteer({ liveView: true });+```+or while using PuppeteerCrawler:+```javascript+const crawler = new PuppeteerCrawler({+ launchPuppeteerOptions: { liveView: true },+ // other options+})+```++For debugging, you may want to add another option: `{ slowMo: 300 }` (see <a href="https://pptr.dev/#?product=Puppeteer&version=v1.6.0&show=api-puppeteerlaunchoptions" target="_blank">Puppeteer documentation</a>).++Puppeteer Live View starts a @ `localhost:4321` by default and will present you with the following screen:+<img src="https://www.apify.com/ext/sdk_assets/puppeteer-live-view-dashboard.png">++Click on the magnifying glass icon will take you to a page detail, showing its screenshot and raw HTML:+<img src="https://www.apify.com/ext/sdk_assets/puppeteer-live-view-detail.png">++For more information see complete <a href="https://www.apify.com/docs/sdk/apify-runtime-js/latest#PuppeteerLiveViewServer" target="_blank">documentation</a>.+## Local usageThe easiest way how to use apify locally is with <a href="https://github.com/apifytech/apify-cli" target="_blank">Apify CLI</a> as shown@@ -456,4 +484,4 @@ and get image as response. Then you can for example use it directly in html:- <a href="https://github.com/apifytech/apify-js/tree/master/examples/autoscaled_pool.js">Use of AutoscaledPool</a>-</div>\ No newline at end of file+</div>