mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
113 lines
4.8 KiB
Plaintext
113 lines
4.8 KiB
Plaintext
---
|
|
title: "Overview"
|
|
description: "Extract data from websites and automate browser interactions with powerful scraping tools"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
These tools enable your agents to interact with the web, extract data from websites, and automate browser-based tasks. From simple web scraping to complex browser automation, these tools cover all your web interaction needs.
|
|
|
|
## **Available Tools**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Scrape Website Tool" icon="globe" href="/en/tools/web-scraping/scrapewebsitetool">
|
|
General-purpose web scraping tool for extracting content from any website.
|
|
</Card>
|
|
|
|
<Card title="Scrape Element Tool" icon="crosshairs" href="/en/tools/web-scraping/scrapeelementfromwebsitetool">
|
|
Target specific elements on web pages with precision scraping capabilities.
|
|
</Card>
|
|
|
|
<Card title="Firecrawl Crawl Tool" icon="spider" href="/en/tools/web-scraping/firecrawlcrawlwebsitetool">
|
|
Crawl entire websites systematically with Firecrawl's powerful engine.
|
|
</Card>
|
|
|
|
<Card title="Firecrawl Scrape Tool" icon="fire" href="/en/tools/web-scraping/firecrawlscrapewebsitetool">
|
|
High-performance web scraping with Firecrawl's advanced capabilities.
|
|
</Card>
|
|
|
|
<Card title="Firecrawl Search Tool" icon="magnifying-glass" href="/en/tools/web-scraping/firecrawlsearchtool">
|
|
Search and extract specific content using Firecrawl's search features.
|
|
</Card>
|
|
|
|
<Card title="Selenium Scraping Tool" icon="robot" href="/en/tools/web-scraping/seleniumscrapingtool">
|
|
Browser automation and scraping with Selenium WebDriver capabilities.
|
|
</Card>
|
|
|
|
<Card title="ScrapFly Tool" icon="plane" href="/en/tools/web-scraping/scrapflyscrapetool">
|
|
Professional web scraping with ScrapFly's premium scraping service.
|
|
</Card>
|
|
|
|
<Card title="ScrapGraph Tool" icon="network-wired" href="/en/tools/web-scraping/scrapegraphscrapetool">
|
|
Graph-based web scraping for complex data relationships.
|
|
</Card>
|
|
|
|
<Card title="Spider Tool" icon="spider" href="/en/tools/web-scraping/spidertool">
|
|
Comprehensive web crawling and data extraction capabilities.
|
|
</Card>
|
|
|
|
<Card title="BrowserBase Tool" icon="browser" href="/en/tools/web-scraping/browserbaseloadtool">
|
|
Cloud-based browser automation with BrowserBase infrastructure.
|
|
</Card>
|
|
|
|
<Card title="HyperBrowser Tool" icon="window-maximize" href="/en/tools/web-scraping/hyperbrowserloadtool">
|
|
Fast browser interactions with HyperBrowser's optimized engine.
|
|
</Card>
|
|
|
|
<Card title="Stagehand Tool" icon="hand" href="/en/tools/web-scraping/stagehandtool">
|
|
Intelligent browser automation with natural language commands.
|
|
</Card>
|
|
|
|
<Card title="Oxylabs Scraper Tool" icon="globe" href="/en/tools/web-scraping/oxylabsscraperstool">
|
|
Access web data at scale with Oxylabs.
|
|
</Card>
|
|
|
|
<Card title="Bright Data Tools" icon="spider" href="/en/tools/web-scraping/brightdata-tools">
|
|
SERP search, Web Unlocker, and Dataset API integrations.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## **Common Use Cases**
|
|
|
|
- **Data Extraction**: Scrape product information, prices, and reviews
|
|
- **Content Monitoring**: Track changes on websites and news sources
|
|
- **Lead Generation**: Extract contact information and business data
|
|
- **Market Research**: Gather competitive intelligence and market data
|
|
- **Testing & QA**: Automate browser testing and validation workflows
|
|
- **Social Media**: Extract posts, comments, and social media analytics
|
|
|
|
## **Quick Start Example**
|
|
|
|
```python
|
|
from crewai_tools import ScrapeWebsiteTool, FirecrawlScrapeWebsiteTool, SeleniumScrapingTool
|
|
|
|
# Create scraping tools
|
|
simple_scraper = ScrapeWebsiteTool()
|
|
advanced_scraper = FirecrawlScrapeWebsiteTool()
|
|
browser_automation = SeleniumScrapingTool()
|
|
|
|
# Add to your agent
|
|
agent = Agent(
|
|
role="Web Research Specialist",
|
|
tools=[simple_scraper, advanced_scraper, browser_automation],
|
|
goal="Extract and analyze web data efficiently"
|
|
)
|
|
```
|
|
|
|
## **Scraping Best Practices**
|
|
|
|
- **Respect robots.txt**: Always check and follow website scraping policies
|
|
- **Rate Limiting**: Implement delays between requests to avoid overwhelming servers
|
|
- **User Agents**: Use appropriate user agent strings to identify your bot
|
|
- **Legal Compliance**: Ensure your scraping activities comply with terms of service
|
|
- **Error Handling**: Implement robust error handling for network issues and blocked requests
|
|
- **Data Quality**: Validate and clean extracted data before processing
|
|
|
|
## **Tool Selection Guide**
|
|
|
|
- **Simple Tasks**: Use `ScrapeWebsiteTool` for basic content extraction
|
|
- **JavaScript-Heavy Sites**: Use `SeleniumScrapingTool` for dynamic content
|
|
- **Scale & Performance**: Use `FirecrawlScrapeWebsiteTool` for high-volume scraping
|
|
- **Cloud Infrastructure**: Use `BrowserBaseLoadTool` for scalable browser automation
|
|
- **Complex Workflows**: Use `StagehandTool` for intelligent browser interactions
|