43 lines
997 B
Markdown
43 lines
997 B
Markdown
---
|
|
name: firecrawl
|
|
description: Web search and scraping via Firecrawl API. Use when you need to search the web, scrape websites (including JS-heavy pages), crawl entire sites, or extract structured data from web pages. Requires FIRECRAWL_API_KEY environment variable.
|
|
---
|
|
|
|
# Firecrawl
|
|
|
|
Web search and scraping via Firecrawl API.
|
|
|
|
## Prerequisites
|
|
|
|
Set `FIRECRAWL_API_KEY` in your environment or `.env` file:
|
|
```bash
|
|
export FIRECRAWL_API_KEY=fc-xxxxxxxxxx
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
### Search the web
|
|
```bash
|
|
firecrawl_search "your search query" --limit 10
|
|
```
|
|
|
|
### Scrape a single page
|
|
```bash
|
|
firecrawl_scrape "https://example.com"
|
|
```
|
|
|
|
### Crawl an entire site
|
|
```bash
|
|
firecrawl_crawl "https://example.com" --max-pages 50
|
|
```
|
|
|
|
## API Reference
|
|
|
|
See [references/api.md](references/api.md) for detailed API documentation and advanced options.
|
|
|
|
## Scripts
|
|
|
|
- `scripts/search.py` - Search the web with Firecrawl
|
|
- `scripts/scrape.py` - Scrape a single URL
|
|
- `scripts/crawl.py` - Crawl an entire website
|