mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
93dafe2637
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>
87 lines
3.3 KiB
Plaintext
87 lines
3.3 KiB
Plaintext
---
|
|
title: Hyperbrowser Load Tool
|
|
description: The `HyperbrowserLoadTool` enables web scraping and crawling using Hyperbrowser.
|
|
icon: globe
|
|
mode: "wide"
|
|
---
|
|
|
|
# `HyperbrowserLoadTool`
|
|
|
|
## Description
|
|
|
|
The `HyperbrowserLoadTool` enables web scraping and crawling using [Hyperbrowser](https://hyperbrowser.ai), a platform for running and scaling headless browsers. This tool allows you to scrape a single page or crawl an entire site, returning the content in properly formatted markdown or HTML.
|
|
|
|
Key Features:
|
|
- Instant Scalability - Spin up hundreds of browser sessions in seconds without infrastructure headaches
|
|
- Simple Integration - Works seamlessly with popular tools like Puppeteer and Playwright
|
|
- Powerful APIs - Easy to use APIs for scraping/crawling any site
|
|
- Bypass Anti-Bot Measures - Built-in stealth mode, ad blocking, automatic CAPTCHA solving, and rotating proxies
|
|
|
|
## Installation
|
|
|
|
To use this tool, you need to install the Hyperbrowser SDK:
|
|
|
|
```shell
|
|
uv add hyperbrowser
|
|
```
|
|
|
|
## Steps to Get Started
|
|
|
|
To effectively use the `HyperbrowserLoadTool`, follow these steps:
|
|
|
|
1. **Sign Up**: Head to [Hyperbrowser](https://app.hyperbrowser.ai/) to sign up and generate an API key.
|
|
2. **API Key**: Set the `HYPERBROWSER_API_KEY` environment variable or pass it directly to the tool constructor.
|
|
3. **Install SDK**: Install the Hyperbrowser SDK using the command above.
|
|
|
|
## Example
|
|
|
|
The following example demonstrates how to initialize the tool and use it to scrape a website:
|
|
|
|
```python Code
|
|
from crewai_tools import HyperbrowserLoadTool
|
|
from crewai import Agent
|
|
|
|
# Initialize the tool with your API key
|
|
tool = HyperbrowserLoadTool(api_key="your_api_key") # Or use environment variable
|
|
|
|
# Define an agent that uses the tool
|
|
@agent
|
|
def web_researcher(self) -> Agent:
|
|
'''
|
|
This agent uses the HyperbrowserLoadTool to scrape websites
|
|
and extract information.
|
|
'''
|
|
return Agent(
|
|
config=self.agents_config["web_researcher"],
|
|
tools=[tool]
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
The `HyperbrowserLoadTool` accepts the following parameters:
|
|
|
|
### Constructor Parameters
|
|
- **api_key**: Optional. Your Hyperbrowser API key. If not provided, it will be read from the `HYPERBROWSER_API_KEY` environment variable.
|
|
|
|
### Run Parameters
|
|
- **url**: Required. The website URL to scrape or crawl.
|
|
- **operation**: Optional. The operation to perform on the website. Either 'scrape' or 'crawl'. Default is 'scrape'.
|
|
- **params**: Optional. Additional parameters for the scrape or crawl operation.
|
|
|
|
## Supported Parameters
|
|
|
|
For detailed information on all supported parameters, visit:
|
|
- [Scrape Parameters](https://docs.hyperbrowser.ai/reference/sdks/python/scrape#start-scrape-job-and-wait)
|
|
- [Crawl Parameters](https://docs.hyperbrowser.ai/reference/sdks/python/crawl#start-crawl-job-and-wait)
|
|
|
|
## Return Format
|
|
|
|
The tool returns content in the following format:
|
|
|
|
- For **scrape** operations: The content of the page in markdown or HTML format.
|
|
- For **crawl** operations: The content of each page separated by dividers, including the URL of each page.
|
|
|
|
## Conclusion
|
|
|
|
The `HyperbrowserLoadTool` provides a powerful way to scrape and crawl websites, handling complex scenarios like anti-bot measures, CAPTCHAs, and more. By leveraging Hyperbrowser's platform, this tool enables agents to access and extract web content efficiently. |