{"_id":"@cassidyai/crawlee-root","_rev":"1-62ff8125cc459184d7fae84d6e060198","name":"@cassidyai/crawlee-root","dist-tags":{"latest":"3.7.3"},"versions":{"3.7.3":{"version":"3.7.3","name":"@cassidyai/crawlee-root","description":"The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.","workspaces":["packages/*"],"keywords":["apify","headless","chrome","puppeteer","crawler","scraper"],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"contributors":[{"name":"Jan Curn","email":"jan@apify.com"},{"name":"Marek Trunkat","email":"marek@apify.com"},{"name":"Ondra Urban","email":"ondra@apify.com"}],"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/apify/crawlee.git"},"bugs":{"url":"https://github.com/apify/crawlee/issues"},"homepage":"https://crawlee.dev","scripts":{"postinstall":"npx husky install","prepublishOnly":"turbo run copy","clean":"turbo run clean","build":"turbo run build && node ./scripts/typescript_fixes.mjs","ci:build":"turbo run build --cache-dir=\".turbo\" && node ./scripts/typescript_fixes.mjs","test":"vitest run --silent","test:e2e":"node test/e2e/run.mjs","test:full":"cross-env CRAWLEE_DIFFICULT_TESTS=1 vitest run --silent","coverage":"vitest --coverage","publish:next":"lerna publish from-package --contents dist --dist-tag next --force-publish","release:next":"yarn build && yarn publish:next","publish:prod":"lerna publish from-package --contents dist --force-publish","release:prod":"yarn build && yarn publish:prod","release:pin-versions":"turbo run copy -- -- --pin-versions","lint":"eslint \"packages/**/*.ts\" \"test/**/*.ts\"","lint:fix":"eslint \"packages/**/*.ts\" \"test/**/*.ts\" --fix"},"devDependencies":{"@apify/eslint-config-ts":"^0.4.0","@apify/log":"^2.4.0","@apify/tsconfig":"^0.1.0","@commitlint/config-conventional":"^18.0.0","@playwright/browser-chromium":"1.40.1","@playwright/browser-firefox":"1.40.1","@playwright/browser-webkit":"1.40.1","@types/content-type":"^1.1.5","@types/deep-equal":"^1.0.1","@types/domhandler":"^2.4.2","@types/express":"^4.17.13","@types/fs-extra":"^11.0.0","@types/htmlparser2":"^3.10.3","@types/inquirer":"^8.2.1","@types/is-ci":"^3.0.1","@types/lodash.merge":"^4.6.7","@types/mime-types":"^2.1.1","@types/node":"^20.0.0","@types/proper-lockfile":"^4.1.2","@types/ps-tree":"^1.1.2","@types/rimraf":"^3.0.2","@types/sax":"^1.0.0","@types/semver":"^7.3.12","@types/stream-json":"^1.7.2","@types/tough-cookie":"^4.0.2","@types/yargs":"^17.0.26","@typescript-eslint/eslint-plugin":"6.18.1","@typescript-eslint/parser":"6.18.1","@vitest/coverage-v8":"^1.0.0","apify":"*","basic-auth-parser":"^0.0.2","body-parser":"^1.20.0","commitlint":"^18.0.0","cross-env":"^7.0.3","deep-equal":"^2.0.5","eslint":"^8.52.0","express":"^4.18.1","fs-extra":"^11.0.0","gen-esm-wrapper":"^1.1.3","globby":"^14.0.0","got":"^13.0.0","husky":"^8.0.1","is-ci":"^3.0.1","lerna":"^8.0.0","lint-staged":"^15.0.0","nock":"^13.4.0","playwright":"1.40.1","portastic":"^1.0.1","proxy":"^1.0.2","puppeteer":"21.7.0","rimraf":"^5.0.0","tsx":"^4.4.0","turbo":"1.11.3","typescript":"^5.2.2","vite-tsconfig-paths":"^4.2.1","vitest":"^1.0.0"},"packageManager":"yarn@4.0.2","volta":{"node":"20.10.0","yarn":"4.0.2"},"gitHead":"c9ad3136dc203357d705d1698b5638c07b5781e5","_id":"@cassidyai/crawlee-root@3.7.3","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-4S3rQe43+okN1mkeOBKSrUJCNbtWeGaTpNcVmzDNbhMzggjnOw2GntNmBqgrU0GhAm8sUqs3HX5pyGY41vgJfQ==","shasum":"57f8da8ab9802135e1154c1fd6c7407b4680ff92","tarball":"https://registry.npmjs.org/@cassidyai/crawlee-root/-/crawlee-root-3.7.3.tgz","fileCount":2109,"unpackedSize":86028122,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGERb6q9SdLZpeR7GQqfqbybCDAkdvtT/RijWsxr0k2QIhALz4iAP91v2kvuszw8/8UfxgO/nyk4djAYWdaEYJCd15"}]},"_npmUser":{"name":"ianwoodfill","email":"ian@cassidyai.com"},"directories":{},"maintainers":[{"name":"ianwoodfill","email":"ian@cassidyai.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/crawlee-root_3.7.3_1704905097869_0.1292074055669623"},"_hasShrinkwrap":false}},"time":{"created":"2024-01-10T16:44:57.812Z","3.7.3":"2024-01-10T16:44:58.477Z","modified":"2024-01-10T17:38:55.497Z"},"maintainers":[{"email":"tristan@cassidyai.com","name":"tdkellar"},{"email":"ian@cassidyai.com","name":"ianwoodfill"}],"description":"The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.","homepage":"https://crawlee.dev","keywords":["apify","headless","chrome","puppeteer","crawler","scraper"],"repository":{"type":"git","url":"git+https://github.com/apify/crawlee.git"},"contributors":[{"name":"Jan Curn","email":"jan@apify.com"},{"name":"Marek Trunkat","email":"marek@apify.com"},{"name":"Ondra Urban","email":"ondra@apify.com"}],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"bugs":{"url":"https://github.com/apify/crawlee/issues"},"license":"Apache-2.0","readme":"

\n \n \n \n \"Crawlee\"\n \n \n
\n A web scraping and browser automation library\n

\n\n

\n \"NPM\n \"Downloads\"\n \"Chat\n \"Build\n

\n\nCrawlee covers your crawling and scraping end-to-end and **helps you build reliable scrapers. Fast.**\n\nYour crawlers will appear human-like and fly under the radar of modern bot protections even with the default configuration. Crawlee gives you the tools to crawl the web for links, scrape data, and store it to disk or cloud while staying configurable to suit your project's needs.\n\nCrawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package.\n\n> 👉 **View full documentation, guides and examples on the [Crawlee project website](https://crawlee.dev)** 👈\n\n## Installation\n\nWe recommend visiting the [Introduction tutorial](https://crawlee.dev/docs/introduction) in Crawlee documentation for more information.\n\n> Crawlee requires **Node.js 16 or higher**.\n\n### With Crawlee CLI\n\nThe fastest way to try Crawlee out is to use the **Crawlee CLI** and choose the **Getting started example**. The CLI will install all the necessary dependencies and add boilerplate code for you to play with.\n\n```bash\nnpx crawlee create my-crawler\n```\n\n```bash\ncd my-crawler\nnpm start\n```\n\n### Manual installation\nIf you prefer adding Crawlee **into your own project**, try the example below. Because it uses `PlaywrightCrawler` we also need to install [Playwright](https://playwright.dev). It's not bundled with Crawlee to reduce install size.\n\n```bash\nnpm install crawlee playwright\n```\n\n```js\nimport { PlaywrightCrawler, Dataset } from 'crawlee';\n\n// PlaywrightCrawler crawls the web using a headless\n// browser controlled by the Playwright library.\nconst crawler = new PlaywrightCrawler({\n // Use the requestHandler to process each of the crawled pages.\n async requestHandler({ request, page, enqueueLinks, log }) {\n const title = await page.title();\n log.info(`Title of ${request.loadedUrl} is '${title}'`);\n\n // Save results as JSON to ./storage/datasets/default\n await Dataset.pushData({ title, url: request.loadedUrl });\n\n // Extract links from the current page\n // and add them to the crawling queue.\n await enqueueLinks();\n },\n // Uncomment this option to see the browser window.\n // headless: false,\n});\n\n// Add first URL to the queue and start the crawl.\nawait crawler.run(['https://crawlee.dev']);\n```\n\nBy default, Crawlee stores data to `./storage` in the current working directory. You can override this directory via Crawlee configuration. For details, see [Configuration guide](https://crawlee.dev/docs/guides/configuration), [Request storage](https://crawlee.dev/docs/guides/request-storage) and [Result storage](https://crawlee.dev/docs/guides/result-storage).\n\n## 🛠 Features\n\n- Single interface for **HTTP and headless browser** crawling\n- Persistent **queue** for URLs to crawl (breadth & depth first)\n- Pluggable **storage** of both tabular data and files\n- Automatic **scaling** with available system resources\n- Integrated **proxy rotation** and session management\n- Lifecycles customizable with **hooks**\n- **CLI** to bootstrap your projects\n- Configurable **routing**, **error handling** and **retries**\n- **Dockerfiles** ready to deploy\n- Written in **TypeScript** with generics\n\n### 👾 HTTP crawling\n\n- Zero config **HTTP2 support**, even for proxies\n- Automatic generation of **browser-like headers**\n- Replication of browser **TLS fingerprints**\n- Integrated fast **HTML parsers**. Cheerio and JSDOM\n- Yes, you can scrape **JSON APIs** as well\n\n### 💻 Real browser crawling\n\n- JavaScript **rendering** and **screenshots**\n- **Headless** and **headful** support\n- Zero-config generation of **human-like fingerprints**\n- Automatic **browser management**\n- Use **Playwright** and **Puppeteer** with the same interface\n- **Chrome**, **Firefox**, **Webkit** and many others\n\n## Usage on the Apify platform\n\nCrawlee is open-source and runs anywhere, but since it's developed by [Apify](https://apify.com), it's easy to set up on the Apify platform and run in the cloud. Visit the [Apify SDK website](https://sdk.apify.com) to learn more about deploying Crawlee to the Apify platform.\n\n## Support\n\nIf you find any bug or issue with Crawlee, please [submit an issue on GitHub](https://github.com/apify/crawlee/issues). For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify), in GitHub Discussions or you can join our [Discord server](https://discord.com/invite/jyEM2PRvMU).\n\n## Contributing\n\nYour code contributions are welcome, and you'll be praised to eternity! If you have any ideas for improvements, either submit an issue or create a pull request. For contribution guidelines and the code of conduct, see [CONTRIBUTING.md](https://github.com/apify/crawlee/blob/master/CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/apify/crawlee/blob/master/LICENSE.md) file for details.\n","readmeFilename":"README.md"}