firecrawl-cli 1.16.1 → 1.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -22
- package/dist/__tests__/commands/search.test.js +134 -179
- package/dist/__tests__/commands/search.test.js.map +1 -1
- package/dist/commands/search-feedback.d.ts +44 -0
- package/dist/commands/search-feedback.d.ts.map +1 -0
- package/dist/commands/search-feedback.js +357 -0
- package/dist/commands/search-feedback.js.map +1 -0
- package/dist/commands/search.d.ts.map +1 -1
- package/dist/commands/search.js +19 -28
- package/dist/commands/search.js.map +1 -1
- package/dist/commands/status.d.ts.map +1 -1
- package/dist/commands/status.js +4 -0
- package/dist/commands/status.js.map +1 -1
- package/dist/index.js +64 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 🔥 Firecrawl CLI
|
|
2
2
|
|
|
3
|
-
Command-line interface for Firecrawl. Search, scrape, and
|
|
3
|
+
Command-line interface for Firecrawl. Search, scrape, interact, crawl, map, and run agent jobs directly from your terminal.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -11,7 +11,7 @@ npm install -g firecrawl-cli
|
|
|
11
11
|
Or set up everything in one command (install CLI globally, authenticate, and add skills across all detected coding editors):
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npx -y firecrawl-cli@1.
|
|
14
|
+
npx -y firecrawl-cli@1.16.2 init -y --browser
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
- `-y` runs setup non-interactively
|
|
@@ -20,7 +20,7 @@ npx -y firecrawl-cli@1.14.8 init -y --browser
|
|
|
20
20
|
|
|
21
21
|
### Setup Skills and MCP
|
|
22
22
|
|
|
23
|
-
If you are using an AI coding agent like Claude Code, you can also install the
|
|
23
|
+
If you are using an AI coding agent like Claude Code, you can also install the skills manually with:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
26
|
firecrawl setup skills
|
|
@@ -32,7 +32,7 @@ This installs skills globally across all detected coding editors by default. Use
|
|
|
32
32
|
|
|
33
33
|
The init command installs both sets of Firecrawl agent skills into AI coding agents (Cursor, Claude Code, Windsurf, etc.):
|
|
34
34
|
|
|
35
|
-
- **CLI skills** — teach agents how to use the Firecrawl CLI for live web work (search, scrape, interact, map, crawl)
|
|
35
|
+
- **CLI skills** — teach agents how to use the Firecrawl CLI for live web work (search, scrape, interact, map, crawl, agent)
|
|
36
36
|
- **Build skills** — teach agents how to integrate Firecrawl into application code (choose endpoints, wire SDKs, set up API keys)
|
|
37
37
|
|
|
38
38
|
To reinstall skills manually:
|
|
@@ -153,6 +153,11 @@ firecrawl scrape https://firecrawl.dev https://firecrawl.dev/blog https://docs.f
|
|
|
153
153
|
| `--exclude-tags <tags>` | Exclude specific HTML tags |
|
|
154
154
|
| `--max-age <milliseconds>` | Maximum age of cached content in milliseconds |
|
|
155
155
|
| `--lockdown` | Enable lockdown mode for the scrape |
|
|
156
|
+
| `--schema <json>` | JSON schema for structured extraction |
|
|
157
|
+
| `--schema-file <path>` | Path to JSON schema file for structured extraction |
|
|
158
|
+
| `--actions <json>` | JSON actions array to run during scrape |
|
|
159
|
+
| `--actions-file <path>` | Path to JSON actions file |
|
|
160
|
+
| `--proxy <proxy>` | Proxy mode for scraping (for example, `auto`, `basic`) |
|
|
156
161
|
| `-o, --output <path>` | Save output to file |
|
|
157
162
|
| `--json` | Output as JSON format |
|
|
158
163
|
| `--pretty` | Pretty print JSON output |
|
|
@@ -353,23 +358,27 @@ firecrawl crawl https://example.com --limit 100 --max-depth 3
|
|
|
353
358
|
|
|
354
359
|
#### Crawl Options
|
|
355
360
|
|
|
356
|
-
| Option
|
|
357
|
-
|
|
|
358
|
-
| `--wait`
|
|
359
|
-
| `--progress`
|
|
360
|
-
| `--limit <n>`
|
|
361
|
-
| `--max-depth <n>`
|
|
362
|
-
| `--include-paths <paths>`
|
|
363
|
-
| `--exclude-paths <paths>`
|
|
364
|
-
| `--sitemap <mode>`
|
|
365
|
-
| `--allow-subdomains`
|
|
366
|
-
| `--allow-external-links`
|
|
367
|
-
| `--crawl-entire-domain`
|
|
368
|
-
| `--ignore-query-parameters`
|
|
369
|
-
| `--delay <ms>`
|
|
370
|
-
| `--max-concurrency <n>`
|
|
371
|
-
| `--
|
|
372
|
-
| `--
|
|
361
|
+
| Option | Description |
|
|
362
|
+
| ------------------------------ | ---------------------------------------- |
|
|
363
|
+
| `--wait` | Wait for crawl to complete |
|
|
364
|
+
| `--progress` | Show progress while waiting |
|
|
365
|
+
| `--limit <n>` | Maximum pages to crawl |
|
|
366
|
+
| `--max-depth <n>` | Maximum crawl depth |
|
|
367
|
+
| `--include-paths <paths>` | Only crawl matching paths |
|
|
368
|
+
| `--exclude-paths <paths>` | Skip matching paths |
|
|
369
|
+
| `--sitemap <mode>` | `include`, `skip`, or `only` |
|
|
370
|
+
| `--allow-subdomains` | Include subdomains |
|
|
371
|
+
| `--allow-external-links` | Follow external links |
|
|
372
|
+
| `--crawl-entire-domain` | Crawl entire domain |
|
|
373
|
+
| `--ignore-query-parameters` | Treat URLs with different params as same |
|
|
374
|
+
| `--delay <ms>` | Delay between requests |
|
|
375
|
+
| `--max-concurrency <n>` | Max concurrent requests |
|
|
376
|
+
| `--scrape-options <json>` | JSON scrape options passed to each page |
|
|
377
|
+
| `--scrape-options-file <path>` | Path to scrape options JSON file |
|
|
378
|
+
| `--webhook <url-or-json>` | Webhook URL or configuration |
|
|
379
|
+
| `--cancel` | Cancel an active crawl job by job ID |
|
|
380
|
+
| `--timeout <seconds>` | Timeout when waiting |
|
|
381
|
+
| `--poll-interval <seconds>` | Status check interval |
|
|
373
382
|
|
|
374
383
|
#### Examples
|
|
375
384
|
|
|
@@ -440,7 +449,9 @@ firecrawl agent <job-id> --wait
|
|
|
440
449
|
| `--schema <json>` | JSON schema for structured output (inline JSON string) |
|
|
441
450
|
| `--schema-file <path>` | Path to JSON schema file for structured output |
|
|
442
451
|
| `--max-credits <number>` | Maximum credits to spend (job fails if exceeded) |
|
|
452
|
+
| `--webhook <url-or-json>` | Webhook URL or configuration |
|
|
443
453
|
| `--status` | Check status of existing agent job |
|
|
454
|
+
| `--cancel` | Cancel an active agent job by job ID |
|
|
444
455
|
| `--wait` | Wait for agent to complete before returning results |
|
|
445
456
|
| `--poll-interval <seconds>` | Polling interval in seconds when waiting (default: 5) |
|
|
446
457
|
| `--timeout <seconds>` | Timeout in seconds when waiting (default: no timeout) |
|
|
@@ -580,7 +591,7 @@ firecrawl --status
|
|
|
580
591
|
```
|
|
581
592
|
|
|
582
593
|
```
|
|
583
|
-
🔥 firecrawl cli v1.
|
|
594
|
+
🔥 firecrawl cli v1.16.2
|
|
584
595
|
|
|
585
596
|
● Authenticated via stored credentials
|
|
586
597
|
Concurrency: 0/100 jobs (parallel scrape limit)
|