@narumitw/pi-firecrawl 0.1.4 → 0.1.10
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 +41 -11
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -1,14 +1,28 @@
|
|
|
1
|
-
# pi-firecrawl
|
|
1
|
+
# 🔥 pi-firecrawl — Firecrawl Web Scraping Tools for Pi Agents
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@narumitw/pi-firecrawl) [](https://pi.dev) [](./LICENSE)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
`@narumitw/pi-firecrawl` is a native [Pi coding agent](https://pi.dev) extension that exposes [Firecrawl](https://www.firecrawl.dev/) scraping, crawling, URL discovery, and search APIs as Pi tools.
|
|
6
|
+
|
|
7
|
+
Use it to give your AI coding agent reliable web research capabilities for documentation lookup, website audits, competitive research, content extraction, and retrieval-friendly markdown scraping.
|
|
8
|
+
|
|
9
|
+
## ✨ Features
|
|
10
|
+
|
|
11
|
+
- Scrape a single URL into markdown, HTML, raw HTML, links, screenshots, or JSON.
|
|
12
|
+
- Start Firecrawl crawl jobs from Pi.
|
|
13
|
+
- Check crawl job status and retrieve completed crawl data.
|
|
14
|
+
- Discover URLs with Firecrawl map.
|
|
15
|
+
- Search the web and optionally scrape search result pages.
|
|
16
|
+
- Supports Firecrawl API endpoint overrides.
|
|
17
|
+
- Never logs or displays your Firecrawl API key.
|
|
18
|
+
|
|
19
|
+
## 📦 Install
|
|
6
20
|
|
|
7
21
|
```bash
|
|
8
22
|
pi install npm:@narumitw/pi-firecrawl
|
|
9
23
|
```
|
|
10
24
|
|
|
11
|
-
Try without installing:
|
|
25
|
+
Try without installing permanently:
|
|
12
26
|
|
|
13
27
|
```bash
|
|
14
28
|
FIRECRAWL_API_KEY=fc-... pi -e npm:@narumitw/pi-firecrawl
|
|
@@ -20,9 +34,9 @@ Try this package locally from the repository root:
|
|
|
20
34
|
FIRECRAWL_API_KEY=fc-... pi -e ./extensions/pi-firecrawl
|
|
21
35
|
```
|
|
22
36
|
|
|
23
|
-
## Configuration
|
|
37
|
+
## ⚙️ Configuration
|
|
24
38
|
|
|
25
|
-
Set a Firecrawl API key before running
|
|
39
|
+
Set a Firecrawl API key before running Pi:
|
|
26
40
|
|
|
27
41
|
```bash
|
|
28
42
|
export FIRECRAWL_API_KEY=fc-your-key
|
|
@@ -36,9 +50,9 @@ export FIRECRAWL_API_URL=https://api.firecrawl.dev/v1
|
|
|
36
50
|
|
|
37
51
|
`FIRECRAWL_BASE_URL` is also accepted for compatibility. The extension never logs or displays the API key.
|
|
38
52
|
|
|
39
|
-
##
|
|
53
|
+
## 🛠️ Pi tools
|
|
40
54
|
|
|
41
|
-
- `firecrawl_scrape` — scrape a single URL and return requested formats such as markdown, HTML, links, or JSON.
|
|
55
|
+
- `firecrawl_scrape` — scrape a single URL and return requested formats such as markdown, HTML, links, screenshots, or JSON.
|
|
42
56
|
- `firecrawl_crawl` — start a site crawl job and return the Firecrawl job id.
|
|
43
57
|
- `firecrawl_crawl_status` — check a crawl job status and retrieve completed crawl data.
|
|
44
58
|
- `firecrawl_map` — discover URLs for a site.
|
|
@@ -46,7 +60,7 @@ export FIRECRAWL_API_URL=https://api.firecrawl.dev/v1
|
|
|
46
60
|
|
|
47
61
|
All tools fail with a clear configuration error when `FIRECRAWL_API_KEY` is missing.
|
|
48
62
|
|
|
49
|
-
## Command
|
|
63
|
+
## 💬 Command
|
|
50
64
|
|
|
51
65
|
```text
|
|
52
66
|
/firecrawl
|
|
@@ -54,7 +68,7 @@ All tools fail with a clear configuration error when `FIRECRAWL_API_KEY` is miss
|
|
|
54
68
|
|
|
55
69
|
Shows whether the extension sees an API key and which Firecrawl API URL it will call.
|
|
56
70
|
|
|
57
|
-
## Examples
|
|
71
|
+
## 🚀 Examples
|
|
58
72
|
|
|
59
73
|
Scrape a page as markdown:
|
|
60
74
|
|
|
@@ -86,7 +100,15 @@ Start a crawl with markdown extraction:
|
|
|
86
100
|
}
|
|
87
101
|
```
|
|
88
102
|
|
|
89
|
-
##
|
|
103
|
+
## 🧠 Use cases
|
|
104
|
+
|
|
105
|
+
- Research documentation from inside Pi.
|
|
106
|
+
- Crawl websites for migration or audit tasks.
|
|
107
|
+
- Extract clean markdown for AI context.
|
|
108
|
+
- Discover URLs before scraping a site.
|
|
109
|
+
- Combine web search with coding-agent implementation work.
|
|
110
|
+
|
|
111
|
+
## 🗂️ Package layout
|
|
90
112
|
|
|
91
113
|
```txt
|
|
92
114
|
extensions/pi-firecrawl/
|
|
@@ -97,3 +119,11 @@ extensions/pi-firecrawl/
|
|
|
97
119
|
├── tsconfig.json
|
|
98
120
|
└── package.json
|
|
99
121
|
```
|
|
122
|
+
|
|
123
|
+
## 🔎 Keywords
|
|
124
|
+
|
|
125
|
+
Pi extension, Pi coding agent, Firecrawl, web scraping, web crawling, URL discovery, web search, markdown extraction, AI research agent, TypeScript Pi tools.
|
|
126
|
+
|
|
127
|
+
## 📄 License
|
|
128
|
+
|
|
129
|
+
MIT. See [`LICENSE`](./LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@narumitw/pi-firecrawl",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.10",
|
|
4
4
|
"description": "Pi extension that exposes Firecrawl web scraping and crawling tools.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -35,5 +35,10 @@
|
|
|
35
35
|
"@biomejs/biome": "2.4.14",
|
|
36
36
|
"@mariozechner/pi-coding-agent": "0.73.0",
|
|
37
37
|
"typescript": "6.0.3"
|
|
38
|
+
},
|
|
39
|
+
"repository": {
|
|
40
|
+
"type": "git",
|
|
41
|
+
"url": "https://github.com/narumiruna/pi-extensions",
|
|
42
|
+
"directory": "extensions/pi-firecrawl"
|
|
38
43
|
}
|
|
39
44
|
}
|