mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18: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>
93 lines
7.0 KiB
Plaintext
93 lines
7.0 KiB
Plaintext
---
|
||
title: Spider Scraper
|
||
description: The `SpiderTool` is designed to extract and read the content of a specified website using Spider.
|
||
icon: spider-web
|
||
mode: "wide"
|
||
---
|
||
|
||
# `SpiderTool`
|
||
|
||
## Description
|
||
|
||
[Spider](https://spider.cloud/?ref=crewai) is the [fastest](https://github.com/spider-rs/spider/blob/main/benches/BENCHMARKS.md#benchmark-results)
|
||
open source scraper and crawler that returns LLM-ready data.
|
||
It converts any website into pure HTML, markdown, metadata or text while enabling you to crawl with custom actions using AI.
|
||
|
||
## Installation
|
||
|
||
To use the `SpiderTool` you need to download the [Spider SDK](https://pypi.org/project/spider-client/)
|
||
and the `crewai[tools]` SDK too:
|
||
|
||
```shell
|
||
pip install spider-client 'crewai[tools]'
|
||
```
|
||
|
||
## Example
|
||
|
||
This example shows you how you can use the `SpiderTool` to enable your agent to scrape and crawl websites.
|
||
The data returned from the Spider API is already LLM-ready, so no need to do any cleaning there.
|
||
|
||
```python Code
|
||
from crewai_tools import SpiderTool
|
||
|
||
def main():
|
||
spider_tool = SpiderTool()
|
||
|
||
searcher = Agent(
|
||
role="Web Research Expert",
|
||
goal="Find related information from specific URL's",
|
||
backstory="An expert web researcher that uses the web extremely well",
|
||
tools=[spider_tool],
|
||
verbose=True,
|
||
)
|
||
|
||
return_metadata = Task(
|
||
description="Scrape https://spider.cloud with a limit of 1 and enable metadata",
|
||
expected_output="Metadata and 10 word summary of spider.cloud",
|
||
agent=searcher
|
||
)
|
||
|
||
crew = Crew(
|
||
agents=[searcher],
|
||
tasks=[
|
||
return_metadata,
|
||
],
|
||
verbose=2
|
||
)
|
||
|
||
crew.kickoff()
|
||
|
||
if __name__ == "__main__":
|
||
main()
|
||
```
|
||
|
||
## Arguments
|
||
| Argument | Type | Description |
|
||
|:------------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
| **api_key** | `string` | Specifies Spider API key. If not specified, it looks for `SPIDER_API_KEY` in environment variables. |
|
||
| **params** | `object` | Optional parameters for the request. Defaults to `{"return_format": "markdown"}` to optimize content for LLMs. |
|
||
| **request** | `string` | Type of request to perform (`http`, `chrome`, `smart`). `smart` defaults to HTTP, switching to JavaScript rendering if needed. |
|
||
| **limit** | `int` | Max pages to crawl per website. Set to `0` or omit for unlimited. |
|
||
| **depth** | `int` | Max crawl depth. Set to `0` for no limit. |
|
||
| **cache** | `bool` | Enables HTTP caching to speed up repeated runs. Default is `true`. |
|
||
| **budget** | `object` | Sets path-based limits for crawled pages, e.g., `{"*":1}` for root page only. |
|
||
| **locale** | `string` | Locale for the request, e.g., `en-US`. |
|
||
| **cookies** | `string` | HTTP cookies for the request. |
|
||
| **stealth** | `bool` | Enables stealth mode for Chrome requests to avoid detection. Default is `true`. |
|
||
| **headers** | `object` | HTTP headers as a map of key-value pairs for all requests. |
|
||
| **metadata** | `bool` | Stores metadata about pages and content, aiding AI interoperability. Defaults to `false`. |
|
||
| **viewport** | `object` | Sets Chrome viewport dimensions. Default is `800x600`. |
|
||
| **encoding** | `string` | Specifies encoding type, e.g., `UTF-8`, `SHIFT_JIS`. |
|
||
| **subdomains** | `bool` | Includes subdomains in the crawl. Default is `false`. |
|
||
| **user_agent** | `string` | Custom HTTP user agent. Defaults to a random agent. |
|
||
| **store_data** | `bool` | Enables data storage for the request. Overrides `storageless` when set. Default is `false`. |
|
||
| **gpt_config** | `object` | Allows AI to generate crawl actions, with optional chaining steps via an array for `"prompt"`. |
|
||
| **fingerprint** | `bool` | Enables advanced fingerprinting for Chrome. |
|
||
| **storageless** | `bool` | Prevents all data storage, including AI embeddings. Default is `false`. |
|
||
| **readability** | `bool` | Pre-processes content for reading via [Mozilla’s readability](https://github.com/mozilla/readability). Improves content for LLMs. |
|
||
| **return_format** | `string` | Format to return data: `markdown`, `raw`, `text`, `html2text`. Use `raw` for default page format. |
|
||
| **proxy_enabled** | `bool` | Enables high-performance proxies to avoid network-level blocking. |
|
||
| **query_selector** | `string` | CSS query selector for content extraction from markup. |
|
||
| **full_resources** | `bool` | Downloads all resources linked to the website. |
|
||
| **request_timeout** | `int` | Timeout in seconds for requests (5-60). Default is `30`. |
|
||
| **run_in_background** | `bool` | Runs the request in the background, useful for data storage and triggering dashboard crawls. No effect if `storageless` is set. | |