ultimate-pi 0.3.1 → 0.4.1

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.
Files changed (184) hide show
  1. package/.agents/skills/harness-decisions/SKILL.md +37 -0
  2. package/.agents/skills/harness-governor/SKILL.md +1 -1
  3. package/.agents/skills/harness-orchestration/SKILL.md +54 -0
  4. package/.agents/skills/harness-plan/SKILL.md +4 -3
  5. package/.agents/skills/harness-sentrux-setup/SKILL.md +57 -0
  6. package/.agents/skills/scrapling-web/SKILL.md +93 -0
  7. package/.pi/PACKAGING.md +1 -0
  8. package/.pi/SYSTEM.md +13 -15
  9. package/.pi/agents/harness/adversary.md +3 -0
  10. package/.pi/agents/harness/evaluator.md +3 -0
  11. package/.pi/agents/harness/executor.md +4 -1
  12. package/.pi/agents/harness/meta-optimizer.md +2 -1
  13. package/.pi/agents/harness/planner.md +22 -1
  14. package/.pi/agents/harness/sentrux-bootstrap.md +42 -0
  15. package/.pi/agents/harness/tie-breaker.md +2 -0
  16. package/.pi/extensions/harness-ask-user.ts +74 -0
  17. package/.pi/extensions/harness-subagents.ts +9 -0
  18. package/.pi/extensions/lib/ask-user/dialog.ts +260 -0
  19. package/.pi/extensions/lib/ask-user/fallback.ts +78 -0
  20. package/.pi/extensions/lib/ask-user/render.ts +66 -0
  21. package/.pi/extensions/lib/ask-user/schema.ts +69 -0
  22. package/.pi/extensions/lib/ask-user/types.ts +41 -0
  23. package/.pi/extensions/lib/ask-user/validate-core.mjs +79 -0
  24. package/.pi/extensions/lib/ask-user/validate.ts +92 -0
  25. package/.pi/extensions/lib/harness-subagents/agent-loader.ts +126 -0
  26. package/.pi/extensions/lib/harness-subagents/agent-manifest.ts +119 -0
  27. package/.pi/extensions/lib/harness-subagents/agent-parser.ts +87 -0
  28. package/.pi/extensions/lib/harness-subagents/blackboard-tool.ts +118 -0
  29. package/.pi/extensions/lib/harness-subagents/blackboard.ts +175 -0
  30. package/.pi/extensions/lib/harness-subagents/spawn-policy.ts +27 -0
  31. package/.pi/extensions/lib/harness-subagents/types-blackboard.ts +27 -0
  32. package/.pi/extensions/lib/harness-subagents/vendored/agent-manager.ts +553 -0
  33. package/.pi/extensions/lib/harness-subagents/vendored/agent-runner.ts +637 -0
  34. package/.pi/extensions/lib/harness-subagents/vendored/agent-types.ts +175 -0
  35. package/.pi/extensions/lib/harness-subagents/vendored/context.ts +59 -0
  36. package/.pi/extensions/lib/harness-subagents/vendored/cross-extension-rpc.ts +134 -0
  37. package/.pi/extensions/lib/harness-subagents/vendored/custom-agents.ts +5 -0
  38. package/.pi/extensions/lib/harness-subagents/vendored/default-agents.ts +123 -0
  39. package/.pi/extensions/lib/harness-subagents/vendored/env.ts +43 -0
  40. package/.pi/extensions/lib/harness-subagents/vendored/group-join.ts +144 -0
  41. package/.pi/extensions/lib/harness-subagents/vendored/index.ts +2447 -0
  42. package/.pi/extensions/lib/harness-subagents/vendored/invocation-config.ts +52 -0
  43. package/.pi/extensions/lib/harness-subagents/vendored/memory.ts +182 -0
  44. package/.pi/extensions/lib/harness-subagents/vendored/model-resolver.ts +92 -0
  45. package/.pi/extensions/lib/harness-subagents/vendored/output-file.ts +115 -0
  46. package/.pi/extensions/lib/harness-subagents/vendored/prompts.ts +103 -0
  47. package/.pi/extensions/lib/harness-subagents/vendored/schedule-store.ts +177 -0
  48. package/.pi/extensions/lib/harness-subagents/vendored/schedule.ts +416 -0
  49. package/.pi/extensions/lib/harness-subagents/vendored/settings.ts +210 -0
  50. package/.pi/extensions/lib/harness-subagents/vendored/skill-loader.ts +108 -0
  51. package/.pi/extensions/lib/harness-subagents/vendored/types.ts +187 -0
  52. package/.pi/extensions/lib/harness-subagents/vendored/ui/agent-widget.ts +637 -0
  53. package/.pi/extensions/lib/harness-subagents/vendored/ui/conversation-viewer.ts +324 -0
  54. package/.pi/extensions/lib/harness-subagents/vendored/ui/schedule-menu.ts +110 -0
  55. package/.pi/extensions/lib/harness-subagents/vendored/usage.ts +71 -0
  56. package/.pi/extensions/lib/harness-subagents/vendored/worktree.ts +195 -0
  57. package/.pi/extensions/lib/harness-vcc-settings.ts +50 -0
  58. package/.pi/extensions/ultimate-pi-vcc.ts +17 -0
  59. package/.pi/harness/README.md +2 -1
  60. package/.pi/harness/agents.manifest.json +80 -0
  61. package/.pi/harness/docs/adrs/0009-sentrux-rules-lifecycle.md +9 -5
  62. package/.pi/harness/docs/adrs/0030-inhouse-vcc-compaction.md +40 -0
  63. package/.pi/harness/docs/adrs/README.md +1 -0
  64. package/.pi/harness/env.harness.template +28 -0
  65. package/.pi/harness/sentrux/architecture.manifest.json +6 -1
  66. package/.pi/prompts/harness-auto.md +2 -2
  67. package/.pi/prompts/harness-plan.md +2 -2
  68. package/.pi/prompts/harness-router-tune.md +2 -2
  69. package/.pi/prompts/harness-run.md +1 -0
  70. package/.pi/prompts/harness-setup.md +179 -340
  71. package/.pi/scripts/README.md +6 -1
  72. package/.pi/scripts/harness-agents-manifest.mjs +123 -0
  73. package/.pi/scripts/harness-cli-verify.sh +60 -11
  74. package/.pi/scripts/harness-generate-model-router.mjs +242 -0
  75. package/.pi/scripts/harness-graphify-bootstrap.sh +1 -6
  76. package/.pi/scripts/harness-resolve-up-pkg.mjs +71 -0
  77. package/.pi/scripts/harness-seed-project-contracts.mjs +33 -1
  78. package/.pi/scripts/harness-sentrux-bootstrap.mjs +146 -0
  79. package/.pi/scripts/harness-sync-env.mjs +148 -0
  80. package/.pi/scripts/harness-verify.mjs +19 -0
  81. package/.pi/scripts/harness-web-search.md +33 -0
  82. package/.pi/scripts/harness-web.py +177 -0
  83. package/.pi/scripts/harness_web/__init__.py +1 -0
  84. package/.pi/scripts/harness_web/config.py +80 -0
  85. package/.pi/scripts/harness_web/output.py +55 -0
  86. package/.pi/scripts/harness_web/scrape.py +120 -0
  87. package/.pi/scripts/harness_web/search_ddg.py +106 -0
  88. package/.pi/scripts/release.sh +338 -0
  89. package/.pi/scripts/sentrux-rules-sync.mjs +29 -7
  90. package/.pi/scripts/vendor-pi-vcc-settings.stub.ts +8 -0
  91. package/.pi/scripts/vendor-sync-pi-vcc.sh +40 -0
  92. package/.pi/settings.example.json +1 -7
  93. package/.sentrux/rules.toml +1 -1
  94. package/AGENTS.md +1 -1
  95. package/CHANGELOG.md +14 -0
  96. package/THIRD_PARTY_NOTICES.md +8 -0
  97. package/package.json +16 -12
  98. package/vendor/pi-vcc/README.md +215 -0
  99. package/vendor/pi-vcc/UPSTREAM_PIN.md +12 -0
  100. package/vendor/pi-vcc/demo.gif +0 -0
  101. package/vendor/pi-vcc/index.ts +12 -0
  102. package/vendor/pi-vcc/package.json +26 -0
  103. package/vendor/pi-vcc/scripts/audit-sessions.ts +88 -0
  104. package/vendor/pi-vcc/scripts/benchmark-real-sessions.ts +25 -0
  105. package/vendor/pi-vcc/scripts/compare-before-after.ts +36 -0
  106. package/vendor/pi-vcc/scripts/dump-branch-output.ts +20 -0
  107. package/vendor/pi-vcc/src/commands/pi-vcc.ts +36 -0
  108. package/vendor/pi-vcc/src/commands/vcc-recall.ts +65 -0
  109. package/vendor/pi-vcc/src/core/brief.ts +381 -0
  110. package/vendor/pi-vcc/src/core/build-sections.ts +79 -0
  111. package/vendor/pi-vcc/src/core/content.ts +60 -0
  112. package/vendor/pi-vcc/src/core/filter-noise.ts +42 -0
  113. package/vendor/pi-vcc/src/core/format-recall.ts +27 -0
  114. package/vendor/pi-vcc/src/core/format.ts +49 -0
  115. package/vendor/pi-vcc/src/core/lineage.ts +26 -0
  116. package/vendor/pi-vcc/src/core/load-messages.ts +41 -0
  117. package/vendor/pi-vcc/src/core/normalize.ts +66 -0
  118. package/vendor/pi-vcc/src/core/recall-scope.ts +14 -0
  119. package/vendor/pi-vcc/src/core/render-entries.ts +55 -0
  120. package/vendor/pi-vcc/src/core/report.ts +237 -0
  121. package/vendor/pi-vcc/src/core/sanitize.ts +5 -0
  122. package/vendor/pi-vcc/src/core/search-entries.ts +221 -0
  123. package/vendor/pi-vcc/src/core/settings.ts +8 -0
  124. package/vendor/pi-vcc/src/core/skill-collapse.ts +35 -0
  125. package/vendor/pi-vcc/src/core/summarize.ts +157 -0
  126. package/vendor/pi-vcc/src/core/tool-args.ts +14 -0
  127. package/vendor/pi-vcc/src/details.ts +7 -0
  128. package/vendor/pi-vcc/src/extract/commits.ts +69 -0
  129. package/vendor/pi-vcc/src/extract/files.ts +80 -0
  130. package/vendor/pi-vcc/src/extract/goals.ts +79 -0
  131. package/vendor/pi-vcc/src/extract/preferences.ts +55 -0
  132. package/vendor/pi-vcc/src/hooks/before-compact.ts +314 -0
  133. package/vendor/pi-vcc/src/sections.ts +12 -0
  134. package/vendor/pi-vcc/src/tools/recall.ts +109 -0
  135. package/vendor/pi-vcc/src/types.ts +14 -0
  136. package/vendor/pi-vcc/tests/before-compact-hook.test.ts +204 -0
  137. package/vendor/pi-vcc/tests/before-compact.test.ts +145 -0
  138. package/vendor/pi-vcc/tests/brief.test.ts +206 -0
  139. package/vendor/pi-vcc/tests/build-sections.test.ts +59 -0
  140. package/vendor/pi-vcc/tests/compile.test.ts +80 -0
  141. package/vendor/pi-vcc/tests/content.test.ts +31 -0
  142. package/vendor/pi-vcc/tests/extract-goals.test.ts +86 -0
  143. package/vendor/pi-vcc/tests/extract-preferences.test.ts +30 -0
  144. package/vendor/pi-vcc/tests/filter-noise.test.ts +61 -0
  145. package/vendor/pi-vcc/tests/fixtures.ts +61 -0
  146. package/vendor/pi-vcc/tests/format-recall.test.ts +30 -0
  147. package/vendor/pi-vcc/tests/format.test.ts +62 -0
  148. package/vendor/pi-vcc/tests/lineage.test.ts +33 -0
  149. package/vendor/pi-vcc/tests/load-messages.test.ts +51 -0
  150. package/vendor/pi-vcc/tests/normalize.test.ts +97 -0
  151. package/vendor/pi-vcc/tests/real-sessions.test.ts +38 -0
  152. package/vendor/pi-vcc/tests/recall-expand.test.ts +15 -0
  153. package/vendor/pi-vcc/tests/recall-scope.test.ts +32 -0
  154. package/vendor/pi-vcc/tests/recall-tool-scope.test.ts +67 -0
  155. package/vendor/pi-vcc/tests/render-entries.test.ts +62 -0
  156. package/vendor/pi-vcc/tests/report.test.ts +44 -0
  157. package/vendor/pi-vcc/tests/sanitize.test.ts +24 -0
  158. package/vendor/pi-vcc/tests/search-entries.test.ts +144 -0
  159. package/vendor/pi-vcc/tests/support/load-session.ts +23 -0
  160. package/vendor/pi-vcc/tests/support/real-sessions.ts +51 -0
  161. package/.agents/skills/firecrawl/SKILL.md +0 -150
  162. package/.agents/skills/firecrawl/rules/install.md +0 -82
  163. package/.agents/skills/firecrawl/rules/security.md +0 -26
  164. package/.agents/skills/firecrawl-agent/SKILL.md +0 -57
  165. package/.agents/skills/firecrawl-build-interact/SKILL.md +0 -67
  166. package/.agents/skills/firecrawl-build-onboarding/SKILL.md +0 -102
  167. package/.agents/skills/firecrawl-build-onboarding/references/auth-flow.md +0 -39
  168. package/.agents/skills/firecrawl-build-onboarding/references/project-setup.md +0 -20
  169. package/.agents/skills/firecrawl-build-onboarding/references/sdk-installation.md +0 -17
  170. package/.agents/skills/firecrawl-build-scrape/SKILL.md +0 -68
  171. package/.agents/skills/firecrawl-build-search/SKILL.md +0 -68
  172. package/.agents/skills/firecrawl-crawl/SKILL.md +0 -58
  173. package/.agents/skills/firecrawl-download/SKILL.md +0 -69
  174. package/.agents/skills/firecrawl-interact/SKILL.md +0 -83
  175. package/.agents/skills/firecrawl-map/SKILL.md +0 -50
  176. package/.agents/skills/firecrawl-parse/SKILL.md +0 -61
  177. package/.agents/skills/firecrawl-scrape/SKILL.md +0 -68
  178. package/.agents/skills/firecrawl-search/SKILL.md +0 -59
  179. package/.pi/pi-vcc-config.json +0 -4
  180. package/firecrawl/.env.template +0 -62
  181. package/firecrawl/README.md +0 -49
  182. package/firecrawl/docker-compose.yaml +0 -201
  183. package/firecrawl/searxng/searxng.env +0 -3
  184. package/firecrawl/searxng/settings.yml +0 -85
@@ -1,69 +0,0 @@
1
- ---
2
- name: firecrawl-download
3
- description: |
4
- Download an entire website as local files — markdown, screenshots, or multiple formats per page. Use this skill when the user wants to save a site locally, download documentation for offline use, bulk-save pages as files, or says "download the site", "save as local files", "offline copy", "download all the docs", or "save for reference". Combines site mapping and scraping into organized local directories.
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl download
11
-
12
- > **Experimental.** Convenience command that combines `map` + `scrape` to save an entire site as local files.
13
-
14
- Maps the site first to discover pages, then scrapes each one into nested directories under `.firecrawl/`. All scrape options work with download. Always pass `-y` to skip the confirmation prompt.
15
-
16
- ## When to use
17
-
18
- - You want to save an entire site (or section) to local files
19
- - You need offline access to documentation or content
20
- - Bulk content extraction with organized file structure
21
-
22
- ## Quick start
23
-
24
- ```bash
25
- # Interactive wizard (picks format, screenshots, paths for you)
26
- firecrawl download https://docs.example.com
27
-
28
- # With screenshots
29
- firecrawl download https://docs.example.com --screenshot --limit 20 -y
30
-
31
- # Multiple formats (each saved as its own file per page)
32
- firecrawl download https://docs.example.com --format markdown,links --screenshot --limit 20 -y
33
- # Creates per page: index.md + links.txt + screenshot.png
34
-
35
- # Filter to specific sections
36
- firecrawl download https://docs.example.com --include-paths "/features,/sdks"
37
-
38
- # Skip translations
39
- firecrawl download https://docs.example.com --exclude-paths "/zh,/ja,/fr,/es,/pt-BR"
40
-
41
- # Full combo
42
- firecrawl download https://docs.example.com \
43
- --include-paths "/features,/sdks" \
44
- --exclude-paths "/zh,/ja" \
45
- --only-main-content \
46
- --screenshot \
47
- -y
48
- ```
49
-
50
- ## Download options
51
-
52
- | Option | Description |
53
- | ------------------------- | -------------------------------------------------------- |
54
- | `--limit <n>` | Max pages to download |
55
- | `--search <query>` | Filter URLs by search query |
56
- | `--include-paths <paths>` | Only download matching paths |
57
- | `--exclude-paths <paths>` | Skip matching paths |
58
- | `--allow-subdomains` | Include subdomain pages |
59
- | `-y` | Skip confirmation prompt (always use in automated flows) |
60
-
61
- ## Scrape options (all work with download)
62
-
63
- `-f <formats>`, `-H`, `-S`, `--screenshot`, `--full-page-screenshot`, `--only-main-content`, `--include-tags`, `--exclude-tags`, `--wait-for`, `--max-age`, `--country`, `--languages`
64
-
65
- ## See also
66
-
67
- - [firecrawl-map](../firecrawl-map/SKILL.md) — just discover URLs without downloading
68
- - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — scrape individual pages
69
- - [firecrawl-crawl](../firecrawl-crawl/SKILL.md) — bulk extract as JSON (not local files)
@@ -1,83 +0,0 @@
1
- ---
2
- name: firecrawl-interact
3
- description: |
4
- Control and interact with a live browser session on any scraped page — click buttons, fill forms, navigate flows, and extract data using natural language prompts or code. Use when the user needs to interact with a webpage beyond simple scraping: logging into a site, submitting forms, clicking through pagination, handling infinite scroll, navigating multi-step checkout or wizard flows, or when a regular scrape failed because content is behind JavaScript interaction. Also useful for authenticated scraping via profiles. Triggers on "interact", "click", "fill out the form", "log in to", "sign in", "submit", "paginated", "next page", "infinite scroll", "interact with the page", "navigate to", "open a session", or "scrape failed".
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl interact
11
-
12
- Interact with scraped pages in a live browser session. Scrape a page first, then use natural language prompts or code to click, fill forms, navigate, and extract data.
13
-
14
- ## When to use
15
-
16
- - Content requires interaction: clicks, form fills, pagination, login
17
- - `scrape` failed because content is behind JavaScript interaction
18
- - You need to navigate a multi-step flow
19
- - Last resort in the [workflow escalation pattern](firecrawl-cli): search → scrape → map → crawl → **interact**
20
- - **Never use interact for web searches** — use `search` instead
21
-
22
- ## Quick start
23
-
24
- ```bash
25
- # 1. Scrape a page (scrape ID is saved automatically)
26
- firecrawl scrape "<url>"
27
-
28
- # 2. Interact with the page using natural language
29
- firecrawl interact --prompt "Click the login button"
30
- firecrawl interact --prompt "Fill in the email field with test@example.com"
31
- firecrawl interact --prompt "Extract the pricing table"
32
-
33
- # 3. Or use code for precise control
34
- firecrawl interact --code "agent-browser click @e5" --language bash
35
- firecrawl interact --code "agent-browser snapshot -i" --language bash
36
-
37
- # 4. Stop the session when done
38
- firecrawl interact stop
39
- ```
40
-
41
- ## Options
42
-
43
- | Option | Description |
44
- | --------------------- | ------------------------------------------------- |
45
- | `--prompt <text>` | Natural language instruction (use this OR --code) |
46
- | `--code <code>` | Code to execute in the browser session |
47
- | `--language <lang>` | Language for code: bash, python, node |
48
- | `--timeout <seconds>` | Execution timeout (default: 30, max: 300) |
49
- | `--scrape-id <id>` | Target a specific scrape (default: last scrape) |
50
- | `-o, --output <path>` | Output file path |
51
-
52
- ## Profiles
53
-
54
- Use `--profile` on the scrape to persist browser state (cookies, localStorage) across scrapes:
55
-
56
- ```bash
57
- # Session 1: Login and save state
58
- firecrawl scrape "https://app.example.com/login" --profile my-app
59
- firecrawl interact --prompt "Fill in email with user@example.com and click login"
60
-
61
- # Session 2: Come back authenticated
62
- firecrawl scrape "https://app.example.com/dashboard" --profile my-app
63
- firecrawl interact --prompt "Extract the dashboard data"
64
- ```
65
-
66
- Read-only reconnect (no writes to profile state):
67
-
68
- ```bash
69
- firecrawl scrape "https://app.example.com" --profile my-app --no-save-changes
70
- ```
71
-
72
- ## Tips
73
-
74
- - Always scrape first — `interact` requires a scrape ID from a previous `firecrawl scrape` call
75
- - The scrape ID is saved automatically, so you don't need `--scrape-id` for subsequent interact calls
76
- - Use `firecrawl interact stop` to free resources when done
77
- - For parallel work, scrape multiple pages and interact with each using `--scrape-id`
78
-
79
- ## See also
80
-
81
- - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — try scrape first, escalate to interact only when needed
82
- - [firecrawl-search](../firecrawl-search/SKILL.md) — for web searches (never use interact for searching)
83
- - [firecrawl-agent](../firecrawl-agent/SKILL.md) — AI-powered extraction (less manual control)
@@ -1,50 +0,0 @@
1
- ---
2
- name: firecrawl-map
3
- description: |
4
- Discover and list all URLs on a website, with optional search filtering. Use this skill when the user wants to find a specific page on a large site, list all URLs, see the site structure, find where something is on a domain, or says "map the site", "find the URL for", "what pages are on", or "list all pages". Essential when the user knows which site but not which exact page.
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl map
11
-
12
- Discover URLs on a site. Use `--search` to find a specific page within a large site.
13
-
14
- ## When to use
15
-
16
- - You need to find a specific subpage on a large site
17
- - You want a list of all URLs on a site before scraping or crawling
18
- - Step 3 in the [workflow escalation pattern](firecrawl-cli): search → scrape → **map** → crawl → interact
19
-
20
- ## Quick start
21
-
22
- ```bash
23
- # Find a specific page on a large site
24
- firecrawl map "<url>" --search "authentication" -o .firecrawl/filtered.txt
25
-
26
- # Get all URLs
27
- firecrawl map "<url>" --limit 500 --json -o .firecrawl/urls.json
28
- ```
29
-
30
- ## Options
31
-
32
- | Option | Description |
33
- | --------------------------------- | ---------------------------- |
34
- | `--limit <n>` | Max number of URLs to return |
35
- | `--search <query>` | Filter URLs by search query |
36
- | `--sitemap <include\|skip\|only>` | Sitemap handling strategy |
37
- | `--include-subdomains` | Include subdomain URLs |
38
- | `--json` | Output as JSON |
39
- | `-o, --output <path>` | Output file path |
40
-
41
- ## Tips
42
-
43
- - **Map + scrape is a common pattern**: use `map --search` to find the right URL, then `scrape` it.
44
- - Example: `map https://docs.example.com --search "auth"` → found `/docs/api/authentication` → `scrape` that URL.
45
-
46
- ## See also
47
-
48
- - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — scrape the URLs you discover
49
- - [firecrawl-crawl](../firecrawl-crawl/SKILL.md) — bulk extract instead of map + scrape
50
- - [firecrawl-download](../firecrawl-download/SKILL.md) — download entire site (uses map internally)
@@ -1,61 +0,0 @@
1
- ---
2
- name: firecrawl-parse
3
- description: |
4
- Efficiently extract and convert the contents of any local file—such as PDF, DOCX, DOC, ODT, RTF, XLSX, XLS, or HTML—into clean, well-formatted markdown saved to disk. Use this skill whenever the user requests to parse, read, or extract information from a file on their computer, including phrases like “parse this PDF”, “convert this document”, “read this file”, “extract text from”, or when a local file path (not a URL) is provided. This skill offers advanced options like generating AI-powered summaries and answering questions based on the file's content. Prefer this tool over `scrape` when handling local files to deliver precise, structured outputs for downstream tasks.
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl parse
11
-
12
- Turn a local document into clean markdown on disk. Supports **PDF, DOCX, DOC, ODT, RTF, XLSX, XLS, HTML/HTM/XHTML**.
13
-
14
- ## When to use
15
-
16
- - You have a file on disk (not a URL) and want its text as markdown
17
- - User drops a PDF/DOCX and asks what it says, or to summarize it
18
- - Use `scrape` instead when the source is a URL
19
-
20
- ## Quick start
21
-
22
- Always save to `.firecrawl/` with `-o` — parsed docs can be hundreds of KB and blow up context if streamed to stdout. Add `.firecrawl/` to `.gitignore`.
23
-
24
- ```bash
25
- mkdir -p .firecrawl
26
-
27
- # File → markdown
28
- firecrawl parse ./paper.pdf -o .firecrawl/paper.md
29
-
30
- # AI summary
31
- firecrawl parse ./paper.pdf -S -o .firecrawl/paper-summary.md
32
-
33
- # Ask a question about the doc
34
- firecrawl parse ./paper.pdf -Q "What are the main conclusions?" \
35
- -o .firecrawl/paper-qa.md
36
- ```
37
-
38
- Then `head`, `grep`, `rg` etc., or incrementally read the file - don't load the whole thing at once.
39
-
40
- ## Options
41
-
42
- | Option | Description |
43
- | ---------------------- | --------------------------------------- |
44
- | `-S, --summary` | AI-generated summary |
45
- | `-Q, --query <prompt>` | Ask a question about the parsed content |
46
- | `-o, --output <path>` | Output file path — **always use this** |
47
- | `-f, --format <fmt>` | `markdown` (default), `html`, `summary` |
48
- | `--timeout <ms>` | Timeout for the parse job |
49
- | `--timing` | Show request duration |
50
-
51
- ## Tips
52
-
53
- - Quote paths with spaces: `firecrawl parse "./My Doc.pdf" -o .firecrawl/mydoc.md`.
54
- - Max upload size: **50 MB** per file.
55
- - Credits: ~1 per PDF page; HTML is 1 flat.
56
- - Check `.firecrawl/` before re-parsing the same file.
57
- - To check your credit balance (recommended for batch processing and similar workflows), use the `firecrawl credit-usage` command.
58
-
59
- ## See also
60
-
61
- - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — same idea for URLs
@@ -1,68 +0,0 @@
1
- ---
2
- name: firecrawl-scrape
3
- description: |
4
- Extract clean markdown from any URL, including JavaScript-rendered SPAs. Use this skill whenever the user provides a URL and wants its content, says "scrape", "grab", "fetch", "pull", "get the page", "extract from this URL", or "read this webpage". Handles JS-rendered pages, multiple concurrent URLs, and returns LLM-optimized markdown. Use this instead of WebFetch for any webpage content extraction.
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl scrape
11
-
12
- Scrape one or more URLs. Returns clean, LLM-optimized markdown. Multiple URLs are scraped concurrently.
13
-
14
- ## When to use
15
-
16
- - You have a specific URL and want its content
17
- - The page is static or JS-rendered (SPA)
18
- - Step 2 in the [workflow escalation pattern](firecrawl-cli): search → **scrape** → map → crawl → interact
19
-
20
- ## Quick start
21
-
22
- ```bash
23
- # Basic markdown extraction
24
- firecrawl scrape "<url>" -o .firecrawl/page.md
25
-
26
- # Main content only, no nav/footer
27
- firecrawl scrape "<url>" --only-main-content -o .firecrawl/page.md
28
-
29
- # Wait for JS to render, then scrape
30
- firecrawl scrape "<url>" --wait-for 3000 -o .firecrawl/page.md
31
-
32
- # Multiple URLs (each saved to .firecrawl/)
33
- firecrawl scrape https://example.com https://example.com/blog https://example.com/docs
34
-
35
- # Get markdown and links together
36
- firecrawl scrape "<url>" --format markdown,links -o .firecrawl/page.json
37
-
38
- # Ask a question about the page
39
- firecrawl scrape "https://example.com/pricing" --query "What is the enterprise plan price?"
40
- ```
41
-
42
- ## Options
43
-
44
- | Option | Description |
45
- | ------------------------ | ---------------------------------------------------------------- |
46
- | `-f, --format <formats>` | Output formats: markdown, html, rawHtml, links, screenshot, json |
47
- | `-Q, --query <prompt>` | Ask a question about the page content (5 credits) |
48
- | `-H` | Include HTTP headers in output |
49
- | `--only-main-content` | Strip nav, footer, sidebar — main content only |
50
- | `--wait-for <ms>` | Wait for JS rendering before scraping |
51
- | `--include-tags <tags>` | Only include these HTML tags |
52
- | `--exclude-tags <tags>` | Exclude these HTML tags |
53
- | `-o, --output <path>` | Output file path |
54
-
55
- ## Tips
56
-
57
- - **Prefer plain scrape over `--query`.** Scrape to a file, then use `grep`, `head`, or read the markdown directly — you can search and reason over the full content yourself. Use `--query` only when you want a single targeted answer without saving the page (costs 5 extra credits).
58
- - **Try scrape before interact.** Scrape handles static pages and JS-rendered SPAs. Only escalate to `interact` when you need interaction (clicks, form fills, pagination).
59
- - Multiple URLs are scraped concurrently — check `firecrawl --status` for your concurrency limit.
60
- - Single format outputs raw content. Multiple formats (e.g., `--format markdown,links`) output JSON.
61
- - Always quote URLs — shell interprets `?` and `&` as special characters.
62
- - Naming convention: `.firecrawl/{site}-{path}.md`
63
-
64
- ## See also
65
-
66
- - [firecrawl-search](../firecrawl-search/SKILL.md) — find pages when you don't have a URL
67
- - [firecrawl-interact](../firecrawl-interact/SKILL.md) — when scrape can't get the content, use `interact` to click, fill forms, etc.
68
- - [firecrawl-download](../firecrawl-download/SKILL.md) — bulk download an entire site to local files
@@ -1,59 +0,0 @@
1
- ---
2
- name: firecrawl-search
3
- description: |
4
- Web search with full page content extraction. Use this skill whenever the user asks to search the web, find articles, research a topic, look something up, find recent news, discover sources, or says "search for", "find me", "look up", "what are people saying about", or "find articles about". Returns real search results with optional full-page markdown — not just snippets. Provides capabilities beyond Claude's built-in WebSearch.
5
- allowed-tools:
6
- - Bash(firecrawl *)
7
- - Bash(npx firecrawl *)
8
- ---
9
-
10
- # firecrawl search
11
-
12
- Web search with optional content scraping. Returns search results as JSON, optionally with full page content.
13
-
14
- ## When to use
15
-
16
- - You don't have a specific URL yet
17
- - You need to find pages, answer questions, or discover sources
18
- - First step in the [workflow escalation pattern](firecrawl-cli): search → scrape → map → crawl → interact
19
-
20
- ## Quick start
21
-
22
- ```bash
23
- # Basic search
24
- firecrawl search "your query" -o .firecrawl/result.json --json
25
-
26
- # Search and scrape full page content from results
27
- firecrawl search "your query" --scrape -o .firecrawl/scraped.json --json
28
-
29
- # News from the past day
30
- firecrawl search "your query" --sources news --tbs qdr:d -o .firecrawl/news.json --json
31
- ```
32
-
33
- ## Options
34
-
35
- | Option | Description |
36
- | ------------------------------------ | --------------------------------------------- |
37
- | `--limit <n>` | Max number of results |
38
- | `--sources <web,images,news>` | Source types to search |
39
- | `--categories <github,research,pdf>` | Filter by category |
40
- | `--tbs <qdr:h\|d\|w\|m\|y>` | Time-based search filter |
41
- | `--location` | Location for search results |
42
- | `--country <code>` | Country code for search |
43
- | `--scrape` | Also scrape full page content for each result |
44
- | `--scrape-formats` | Formats when scraping (default: markdown) |
45
- | `-o, --output <path>` | Output file path |
46
- | `--json` | Output as JSON |
47
-
48
- ## Tips
49
-
50
- - **`--scrape` fetches full content** — don't re-scrape URLs from search results. This saves credits and avoids redundant fetches.
51
- - Always write results to `.firecrawl/` with `-o` to avoid context window bloat.
52
- - Use `jq` to extract URLs or titles: `jq -r '.data.web[].url' .firecrawl/search.json`
53
- - Naming convention: `.firecrawl/search-{query}.json` or `.firecrawl/search-{query}-scraped.json`
54
-
55
- ## See also
56
-
57
- - [firecrawl-scrape](../firecrawl-scrape/SKILL.md) — scrape a specific URL
58
- - [firecrawl-map](../firecrawl-map/SKILL.md) — discover URLs within a site
59
- - [firecrawl-crawl](../firecrawl-crawl/SKILL.md) — bulk extract from a site
@@ -1,4 +0,0 @@
1
- {
2
- "overrideDefaultCompaction": true,
3
- "debug": false
4
- }
@@ -1,62 +0,0 @@
1
- # Firecrawl Self-Hosted Configuration Template
2
- # Copy to .env and adjust values as needed.
3
-
4
- # === API Service ===
5
- PORT=3002
6
- INTERNAL_PORT=3002
7
- HOST=0.0.0.0
8
- ENV=local
9
-
10
- # === Redis ===
11
- REDIS_URL=redis://redis:6379
12
-
13
- # === PostgreSQL (NUQ) ===
14
- POSTGRES_USER=postgres
15
- POSTGRES_PASSWORD=postgres
16
- POSTGRES_DB=postgres
17
- POSTGRES_HOST=nuq-postgres
18
- POSTGRES_PORT=5432
19
- USE_DB_AUTHENTICATION=false
20
-
21
- # === Queue / Workers ===
22
- NUM_WORKERS_PER_QUEUE=8
23
- CRAWL_CONCURRENT_REQUESTS=10
24
- MAX_CONCURRENT_JOBS=5
25
- BROWSER_POOL_SIZE=5
26
- BULL_AUTH_KEY=changeme
27
- TEST_API_KEY=
28
-
29
- # === Playwright Browser Service ===
30
- PLAYWRIGHT_MICROSERVICE_URL=http://playwright-service:3000/scrape
31
- BLOCK_MEDIA=false
32
- ALLOW_LOCAL_WEBHOOKS=true
33
- MAX_CONCURRENT_PAGES=10
34
-
35
- # === AI / LLM (optional) ===
36
- # OPENAI_API_KEY=
37
- # OPENAI_BASE_URL=
38
- # MODEL_NAME=
39
- # MODEL_EMBEDDING_NAME=
40
- # OLLAMA_BASE_URL=
41
-
42
- # === Integrations ===
43
- # AUTUMN_SECRET_KEY=
44
- # SLACK_WEBHOOK_URL=
45
- # SUPABASE_ANON_TOKEN=
46
- # SUPABASE_URL=
47
- # SUPABASE_SERVICE_TOKEN=
48
- # SELF_HOSTED_WEBHOOK_URL=
49
-
50
- # === Proxy (optional) ===
51
- # PROXY_SERVER=
52
- # PROXY_USERNAME=
53
- # PROXY_PASSWORD=
54
-
55
- # === Logging ===
56
- LOGGING_LEVEL=info
57
-
58
- # === SearXNG ===
59
- SEARXNG_ENDPOINT=http://searxng:8080
60
- SEARXNG_ENGINES=google,bing,duckduckgo
61
- SEARXNG_CATEGORIES=general,science,technology
62
- SEARXNG_EXTERNAL_PORT=8080
@@ -1,49 +0,0 @@
1
- # Firecrawl Self-Hosted
2
-
3
- Web scraping infrastructure for the pi harness. Runs entirely in Docker — no local source checkout needed.
4
-
5
- ## Quick Start
6
-
7
- ```bash
8
- # 1. Create your env file
9
- cp .env.template .env
10
- # Edit .env if needed (defaults work for local dev)
11
-
12
- # 2. Pull pre-built images and start
13
- docker compose -f firecrawl/docker-compose.yaml up -d
14
-
15
- # 3. Verify
16
- curl http://localhost:3002/v1/health
17
- ```
18
-
19
- ## Services
20
-
21
- | Service | Port | Description |
22
- |---------|------|-------------|
23
- | `api` | 3002 | Firecrawl API + Bull queue UI at `/admin/<BULL_AUTH_KEY>/queues` |
24
- | `playwright-service` | 3000 (internal) | Headless browser rendering |
25
- | `redis` | 6379 (internal) | Job queue backing store |
26
- | `rabbitmq` | 5672 (internal) | Message broker for workers |
27
- | `nuq-postgres` | 5432 (internal) | Crawl state persistence |
28
- | `searxng` | 8080 | Metasearch engine for `/search` API |
29
- | `searxng-valkey` | 6379 (internal) | SearXNG cache |
30
-
31
- ## Configuration
32
-
33
- All config lives in `.env`. See `.env.template` for all available options.
34
-
35
- ### Enabling AI features
36
-
37
- Uncomment and set `OPENAI_API_KEY` in `.env`. Also supports Ollama and any OpenAI-compatible endpoint.
38
-
39
- ### Using local builds instead of pre-built images
40
-
41
- Flip the `image:` ↔ `build:` lines in `docker-compose.yaml` for `api`, `playwright-service`, and `nuq-postgres`. You'll need the Firecrawl repo checked out alongside this one at `../firecrawl-selfhosted/apps/`.
42
-
43
- ## SDK Usage
44
-
45
- When using Firecrawl SDKs with a self-hosted instance, pass the base URL — no API key required:
46
-
47
- ```js
48
- const client = new Firecrawl({ apiKey: "", baseUrl: "http://localhost:3002" });
49
- ```