aidevops 2.52.1 → 2.53.2

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 (334) hide show
  1. package/README.md +1 -1
  2. package/VERSION +1 -1
  3. package/aidevops.sh +15 -9
  4. package/package.json +4 -4
  5. package/scripts/npm-postinstall.js +6 -7
  6. package/setup.sh +1 -1
  7. package/templates/deploy-templates.sh +144 -0
  8. package/templates/home/.agent/README.md +33 -0
  9. package/templates/home/AGENTS.md +96 -0
  10. package/templates/home/git/.agent/README.md +48 -0
  11. package/templates/home/git/AGENTS.md +97 -0
  12. package/templates/standard-functions.sh +179 -0
  13. package/templates/wordpress-performance-workflow.md +217 -0
  14. package/.agent/AGENTS.md +0 -614
  15. package/.agent/accounts.md +0 -65
  16. package/.agent/aidevops/add-new-mcp-to-aidevops.md +0 -456
  17. package/.agent/aidevops/api-integrations.md +0 -335
  18. package/.agent/aidevops/architecture.md +0 -510
  19. package/.agent/aidevops/configs.md +0 -274
  20. package/.agent/aidevops/docs.md +0 -244
  21. package/.agent/aidevops/extension.md +0 -311
  22. package/.agent/aidevops/mcp-integrations.md +0 -340
  23. package/.agent/aidevops/mcp-troubleshooting.md +0 -162
  24. package/.agent/aidevops/memory-patterns.md +0 -172
  25. package/.agent/aidevops/providers.md +0 -217
  26. package/.agent/aidevops/recommendations.md +0 -321
  27. package/.agent/aidevops/requirements.md +0 -301
  28. package/.agent/aidevops/resources.md +0 -214
  29. package/.agent/aidevops/security-requirements.md +0 -174
  30. package/.agent/aidevops/security.md +0 -350
  31. package/.agent/aidevops/service-links.md +0 -400
  32. package/.agent/aidevops/services.md +0 -357
  33. package/.agent/aidevops/setup.md +0 -153
  34. package/.agent/aidevops/troubleshooting.md +0 -389
  35. package/.agent/aidevops.md +0 -124
  36. package/.agent/build-plus.md +0 -244
  37. package/.agent/content/guidelines.md +0 -109
  38. package/.agent/content.md +0 -87
  39. package/.agent/health.md +0 -59
  40. package/.agent/legal.md +0 -59
  41. package/.agent/loop-state/full-loop.local.md +0 -16
  42. package/.agent/loop-state/ralph-loop.local.md +0 -10
  43. package/.agent/marketing.md +0 -440
  44. package/.agent/memory/README.md +0 -260
  45. package/.agent/onboarding.md +0 -796
  46. package/.agent/plan-plus.md +0 -245
  47. package/.agent/research.md +0 -100
  48. package/.agent/sales.md +0 -333
  49. package/.agent/scripts/101domains-helper.sh +0 -701
  50. package/.agent/scripts/add-missing-returns.sh +0 -140
  51. package/.agent/scripts/agent-browser-helper.sh +0 -311
  52. package/.agent/scripts/agno-setup.sh +0 -712
  53. package/.agent/scripts/ahrefs-mcp-wrapper.js +0 -168
  54. package/.agent/scripts/aidevops-update-check.sh +0 -71
  55. package/.agent/scripts/ampcode-cli.sh +0 -522
  56. package/.agent/scripts/auto-version-bump.sh +0 -156
  57. package/.agent/scripts/autogen-helper.sh +0 -512
  58. package/.agent/scripts/beads-sync-helper.sh +0 -596
  59. package/.agent/scripts/closte-helper.sh +0 -5
  60. package/.agent/scripts/cloudron-helper.sh +0 -321
  61. package/.agent/scripts/codacy-cli-chunked.sh +0 -581
  62. package/.agent/scripts/codacy-cli.sh +0 -442
  63. package/.agent/scripts/code-audit-helper.sh +0 -5
  64. package/.agent/scripts/coderabbit-cli.sh +0 -417
  65. package/.agent/scripts/coderabbit-pro-analysis.sh +0 -238
  66. package/.agent/scripts/commands/code-simplifier.md +0 -86
  67. package/.agent/scripts/commands/full-loop.md +0 -246
  68. package/.agent/scripts/commands/postflight-loop.md +0 -103
  69. package/.agent/scripts/commands/recall.md +0 -182
  70. package/.agent/scripts/commands/remember.md +0 -132
  71. package/.agent/scripts/commands/save-todo.md +0 -175
  72. package/.agent/scripts/commands/session-review.md +0 -154
  73. package/.agent/scripts/comprehensive-quality-fix.sh +0 -106
  74. package/.agent/scripts/context-builder-helper.sh +0 -522
  75. package/.agent/scripts/coolify-cli-helper.sh +0 -674
  76. package/.agent/scripts/coolify-helper.sh +0 -380
  77. package/.agent/scripts/crawl4ai-examples.sh +0 -401
  78. package/.agent/scripts/crawl4ai-helper.sh +0 -1078
  79. package/.agent/scripts/crewai-helper.sh +0 -681
  80. package/.agent/scripts/dev-browser-helper.sh +0 -513
  81. package/.agent/scripts/dns-helper.sh +0 -396
  82. package/.agent/scripts/domain-research-helper.sh +0 -917
  83. package/.agent/scripts/dspy-helper.sh +0 -285
  84. package/.agent/scripts/dspyground-helper.sh +0 -291
  85. package/.agent/scripts/eeat-score-helper.sh +0 -1242
  86. package/.agent/scripts/efficient-return-fix.sh +0 -92
  87. package/.agent/scripts/extract-opencode-prompts.sh +0 -128
  88. package/.agent/scripts/find-missing-returns.sh +0 -113
  89. package/.agent/scripts/fix-auth-headers.sh +0 -104
  90. package/.agent/scripts/fix-common-strings.sh +0 -254
  91. package/.agent/scripts/fix-content-type.sh +0 -100
  92. package/.agent/scripts/fix-error-messages.sh +0 -130
  93. package/.agent/scripts/fix-misplaced-returns.sh +0 -74
  94. package/.agent/scripts/fix-remaining-literals.sh +0 -152
  95. package/.agent/scripts/fix-return-statements.sh +0 -41
  96. package/.agent/scripts/fix-s131-default-cases.sh +0 -249
  97. package/.agent/scripts/fix-sc2155-simple.sh +0 -102
  98. package/.agent/scripts/fix-shellcheck-critical.sh +0 -187
  99. package/.agent/scripts/fix-string-literals.sh +0 -273
  100. package/.agent/scripts/full-loop-helper.sh +0 -773
  101. package/.agent/scripts/generate-opencode-agents.sh +0 -497
  102. package/.agent/scripts/generate-opencode-commands.sh +0 -1629
  103. package/.agent/scripts/generate-skills.sh +0 -366
  104. package/.agent/scripts/git-platforms-helper.sh +0 -640
  105. package/.agent/scripts/gitea-cli-helper.sh +0 -743
  106. package/.agent/scripts/github-cli-helper.sh +0 -702
  107. package/.agent/scripts/gitlab-cli-helper.sh +0 -682
  108. package/.agent/scripts/gsc-add-user-helper.sh +0 -325
  109. package/.agent/scripts/gsc-sitemap-helper.sh +0 -678
  110. package/.agent/scripts/hetzner-helper.sh +0 -485
  111. package/.agent/scripts/hostinger-helper.sh +0 -229
  112. package/.agent/scripts/keyword-research-helper.sh +0 -1815
  113. package/.agent/scripts/langflow-helper.sh +0 -544
  114. package/.agent/scripts/linkedin-automation.py +0 -241
  115. package/.agent/scripts/linter-manager.sh +0 -599
  116. package/.agent/scripts/linters-local.sh +0 -434
  117. package/.agent/scripts/list-keys-helper.sh +0 -488
  118. package/.agent/scripts/local-browser-automation.py +0 -339
  119. package/.agent/scripts/localhost-helper.sh +0 -744
  120. package/.agent/scripts/loop-common.sh +0 -806
  121. package/.agent/scripts/mainwp-helper.sh +0 -728
  122. package/.agent/scripts/markdown-formatter.sh +0 -338
  123. package/.agent/scripts/markdown-lint-fix.sh +0 -311
  124. package/.agent/scripts/mass-fix-returns.sh +0 -58
  125. package/.agent/scripts/mcp-diagnose.sh +0 -167
  126. package/.agent/scripts/mcp-inspector-helper.sh +0 -449
  127. package/.agent/scripts/memory-helper.sh +0 -650
  128. package/.agent/scripts/monitor-code-review.sh +0 -255
  129. package/.agent/scripts/onboarding-helper.sh +0 -706
  130. package/.agent/scripts/opencode-github-setup-helper.sh +0 -797
  131. package/.agent/scripts/opencode-test-helper.sh +0 -213
  132. package/.agent/scripts/pagespeed-helper.sh +0 -464
  133. package/.agent/scripts/pandoc-helper.sh +0 -362
  134. package/.agent/scripts/postflight-check.sh +0 -555
  135. package/.agent/scripts/pre-commit-hook.sh +0 -259
  136. package/.agent/scripts/pre-edit-check.sh +0 -169
  137. package/.agent/scripts/qlty-cli.sh +0 -356
  138. package/.agent/scripts/quality-cli-manager.sh +0 -525
  139. package/.agent/scripts/quality-feedback-helper.sh +0 -462
  140. package/.agent/scripts/quality-fix.sh +0 -263
  141. package/.agent/scripts/quality-loop-helper.sh +0 -1108
  142. package/.agent/scripts/ralph-loop-helper.sh +0 -836
  143. package/.agent/scripts/ralph-upstream-check.sh +0 -341
  144. package/.agent/scripts/secretlint-helper.sh +0 -847
  145. package/.agent/scripts/servers-helper.sh +0 -241
  146. package/.agent/scripts/ses-helper.sh +0 -619
  147. package/.agent/scripts/session-review-helper.sh +0 -404
  148. package/.agent/scripts/setup-linters-wizard.sh +0 -379
  149. package/.agent/scripts/setup-local-api-keys.sh +0 -330
  150. package/.agent/scripts/setup-mcp-integrations.sh +0 -472
  151. package/.agent/scripts/shared-constants.sh +0 -246
  152. package/.agent/scripts/site-crawler-helper.sh +0 -1487
  153. package/.agent/scripts/snyk-helper.sh +0 -940
  154. package/.agent/scripts/sonarcloud-autofix.sh +0 -193
  155. package/.agent/scripts/sonarcloud-cli.sh +0 -191
  156. package/.agent/scripts/sonarscanner-cli.sh +0 -455
  157. package/.agent/scripts/spaceship-helper.sh +0 -747
  158. package/.agent/scripts/stagehand-helper.sh +0 -321
  159. package/.agent/scripts/stagehand-python-helper.sh +0 -321
  160. package/.agent/scripts/stagehand-python-setup.sh +0 -441
  161. package/.agent/scripts/stagehand-setup.sh +0 -439
  162. package/.agent/scripts/system-cleanup.sh +0 -340
  163. package/.agent/scripts/terminal-title-helper.sh +0 -388
  164. package/.agent/scripts/terminal-title-setup.sh +0 -549
  165. package/.agent/scripts/test-stagehand-both-integration.sh +0 -317
  166. package/.agent/scripts/test-stagehand-integration.sh +0 -309
  167. package/.agent/scripts/test-stagehand-python-integration.sh +0 -341
  168. package/.agent/scripts/todo-ready.sh +0 -263
  169. package/.agent/scripts/tool-version-check.sh +0 -362
  170. package/.agent/scripts/toon-helper.sh +0 -469
  171. package/.agent/scripts/twilio-helper.sh +0 -917
  172. package/.agent/scripts/updown-helper.sh +0 -279
  173. package/.agent/scripts/validate-mcp-integrations.sh +0 -250
  174. package/.agent/scripts/validate-version-consistency.sh +0 -131
  175. package/.agent/scripts/vaultwarden-helper.sh +0 -597
  176. package/.agent/scripts/vercel-cli-helper.sh +0 -816
  177. package/.agent/scripts/verify-mirrors.sh +0 -169
  178. package/.agent/scripts/version-manager.sh +0 -831
  179. package/.agent/scripts/webhosting-helper.sh +0 -471
  180. package/.agent/scripts/webhosting-verify.sh +0 -238
  181. package/.agent/scripts/wordpress-mcp-helper.sh +0 -508
  182. package/.agent/scripts/worktree-helper.sh +0 -595
  183. package/.agent/scripts/worktree-sessions.sh +0 -577
  184. package/.agent/seo/dataforseo.md +0 -215
  185. package/.agent/seo/domain-research.md +0 -532
  186. package/.agent/seo/eeat-score.md +0 -659
  187. package/.agent/seo/google-search-console.md +0 -366
  188. package/.agent/seo/gsc-sitemaps.md +0 -282
  189. package/.agent/seo/keyword-research.md +0 -521
  190. package/.agent/seo/serper.md +0 -278
  191. package/.agent/seo/site-crawler.md +0 -387
  192. package/.agent/seo.md +0 -236
  193. package/.agent/services/accounting/quickfile.md +0 -159
  194. package/.agent/services/communications/telfon.md +0 -470
  195. package/.agent/services/communications/twilio.md +0 -569
  196. package/.agent/services/crm/fluentcrm.md +0 -449
  197. package/.agent/services/email/ses.md +0 -399
  198. package/.agent/services/hosting/101domains.md +0 -378
  199. package/.agent/services/hosting/closte.md +0 -177
  200. package/.agent/services/hosting/cloudflare.md +0 -251
  201. package/.agent/services/hosting/cloudron.md +0 -478
  202. package/.agent/services/hosting/dns-providers.md +0 -335
  203. package/.agent/services/hosting/domain-purchasing.md +0 -344
  204. package/.agent/services/hosting/hetzner.md +0 -327
  205. package/.agent/services/hosting/hostinger.md +0 -287
  206. package/.agent/services/hosting/localhost.md +0 -419
  207. package/.agent/services/hosting/spaceship.md +0 -353
  208. package/.agent/services/hosting/webhosting.md +0 -330
  209. package/.agent/social-media.md +0 -69
  210. package/.agent/templates/plans-template.md +0 -114
  211. package/.agent/templates/prd-template.md +0 -129
  212. package/.agent/templates/tasks-template.md +0 -108
  213. package/.agent/templates/todo-template.md +0 -89
  214. package/.agent/tools/ai-assistants/agno.md +0 -471
  215. package/.agent/tools/ai-assistants/capsolver.md +0 -326
  216. package/.agent/tools/ai-assistants/configuration.md +0 -221
  217. package/.agent/tools/ai-assistants/overview.md +0 -209
  218. package/.agent/tools/ai-assistants/status.md +0 -171
  219. package/.agent/tools/ai-assistants/windsurf.md +0 -193
  220. package/.agent/tools/ai-orchestration/autogen.md +0 -406
  221. package/.agent/tools/ai-orchestration/crewai.md +0 -445
  222. package/.agent/tools/ai-orchestration/langflow.md +0 -405
  223. package/.agent/tools/ai-orchestration/openprose.md +0 -487
  224. package/.agent/tools/ai-orchestration/overview.md +0 -362
  225. package/.agent/tools/ai-orchestration/packaging.md +0 -647
  226. package/.agent/tools/browser/agent-browser.md +0 -464
  227. package/.agent/tools/browser/browser-automation.md +0 -400
  228. package/.agent/tools/browser/chrome-devtools.md +0 -282
  229. package/.agent/tools/browser/crawl4ai-integration.md +0 -422
  230. package/.agent/tools/browser/crawl4ai-resources.md +0 -277
  231. package/.agent/tools/browser/crawl4ai-usage.md +0 -416
  232. package/.agent/tools/browser/crawl4ai.md +0 -585
  233. package/.agent/tools/browser/dev-browser.md +0 -341
  234. package/.agent/tools/browser/pagespeed.md +0 -260
  235. package/.agent/tools/browser/playwright.md +0 -266
  236. package/.agent/tools/browser/playwriter.md +0 -310
  237. package/.agent/tools/browser/stagehand-examples.md +0 -456
  238. package/.agent/tools/browser/stagehand-python.md +0 -483
  239. package/.agent/tools/browser/stagehand.md +0 -421
  240. package/.agent/tools/build-agent/agent-review.md +0 -224
  241. package/.agent/tools/build-agent/build-agent.md +0 -784
  242. package/.agent/tools/build-mcp/aidevops-plugin.md +0 -476
  243. package/.agent/tools/build-mcp/api-wrapper.md +0 -445
  244. package/.agent/tools/build-mcp/build-mcp.md +0 -240
  245. package/.agent/tools/build-mcp/deployment.md +0 -401
  246. package/.agent/tools/build-mcp/server-patterns.md +0 -632
  247. package/.agent/tools/build-mcp/transports.md +0 -366
  248. package/.agent/tools/code-review/auditing.md +0 -383
  249. package/.agent/tools/code-review/automation.md +0 -219
  250. package/.agent/tools/code-review/best-practices.md +0 -203
  251. package/.agent/tools/code-review/codacy.md +0 -151
  252. package/.agent/tools/code-review/code-simplifier.md +0 -174
  253. package/.agent/tools/code-review/code-standards.md +0 -309
  254. package/.agent/tools/code-review/coderabbit.md +0 -101
  255. package/.agent/tools/code-review/management.md +0 -155
  256. package/.agent/tools/code-review/qlty.md +0 -248
  257. package/.agent/tools/code-review/secretlint.md +0 -565
  258. package/.agent/tools/code-review/setup.md +0 -250
  259. package/.agent/tools/code-review/snyk.md +0 -563
  260. package/.agent/tools/code-review/tools.md +0 -230
  261. package/.agent/tools/content/summarize.md +0 -353
  262. package/.agent/tools/context/augment-context-engine.md +0 -468
  263. package/.agent/tools/context/context-builder-agent.md +0 -76
  264. package/.agent/tools/context/context-builder.md +0 -375
  265. package/.agent/tools/context/context7.md +0 -371
  266. package/.agent/tools/context/dspy.md +0 -302
  267. package/.agent/tools/context/dspyground.md +0 -374
  268. package/.agent/tools/context/llm-tldr.md +0 -219
  269. package/.agent/tools/context/osgrep.md +0 -488
  270. package/.agent/tools/context/prompt-optimization.md +0 -338
  271. package/.agent/tools/context/toon.md +0 -292
  272. package/.agent/tools/conversion/pandoc.md +0 -304
  273. package/.agent/tools/credentials/api-key-management.md +0 -154
  274. package/.agent/tools/credentials/api-key-setup.md +0 -224
  275. package/.agent/tools/credentials/environment-variables.md +0 -180
  276. package/.agent/tools/credentials/vaultwarden.md +0 -382
  277. package/.agent/tools/data-extraction/outscraper.md +0 -974
  278. package/.agent/tools/deployment/coolify-cli.md +0 -388
  279. package/.agent/tools/deployment/coolify-setup.md +0 -353
  280. package/.agent/tools/deployment/coolify.md +0 -345
  281. package/.agent/tools/deployment/vercel.md +0 -390
  282. package/.agent/tools/git/authentication.md +0 -132
  283. package/.agent/tools/git/gitea-cli.md +0 -193
  284. package/.agent/tools/git/github-actions.md +0 -207
  285. package/.agent/tools/git/github-cli.md +0 -223
  286. package/.agent/tools/git/gitlab-cli.md +0 -190
  287. package/.agent/tools/git/opencode-github-security.md +0 -350
  288. package/.agent/tools/git/opencode-github.md +0 -328
  289. package/.agent/tools/git/opencode-gitlab.md +0 -252
  290. package/.agent/tools/git/security.md +0 -196
  291. package/.agent/tools/git.md +0 -207
  292. package/.agent/tools/opencode/oh-my-opencode.md +0 -375
  293. package/.agent/tools/opencode/opencode-anthropic-auth.md +0 -446
  294. package/.agent/tools/opencode/opencode.md +0 -651
  295. package/.agent/tools/social-media/bird.md +0 -437
  296. package/.agent/tools/task-management/beads.md +0 -336
  297. package/.agent/tools/terminal/terminal-title.md +0 -251
  298. package/.agent/tools/ui/shadcn.md +0 -196
  299. package/.agent/tools/ui/ui-skills.md +0 -115
  300. package/.agent/tools/wordpress/localwp.md +0 -311
  301. package/.agent/tools/wordpress/mainwp.md +0 -391
  302. package/.agent/tools/wordpress/scf.md +0 -527
  303. package/.agent/tools/wordpress/wp-admin.md +0 -729
  304. package/.agent/tools/wordpress/wp-dev.md +0 -940
  305. package/.agent/tools/wordpress/wp-preferred.md +0 -398
  306. package/.agent/tools/wordpress.md +0 -95
  307. package/.agent/workflows/branch/bugfix.md +0 -63
  308. package/.agent/workflows/branch/chore.md +0 -95
  309. package/.agent/workflows/branch/experiment.md +0 -115
  310. package/.agent/workflows/branch/feature.md +0 -59
  311. package/.agent/workflows/branch/hotfix.md +0 -98
  312. package/.agent/workflows/branch/refactor.md +0 -92
  313. package/.agent/workflows/branch/release.md +0 -96
  314. package/.agent/workflows/branch.md +0 -347
  315. package/.agent/workflows/bug-fixing.md +0 -267
  316. package/.agent/workflows/changelog.md +0 -129
  317. package/.agent/workflows/code-audit-remote.md +0 -279
  318. package/.agent/workflows/conversation-starter.md +0 -69
  319. package/.agent/workflows/error-feedback.md +0 -578
  320. package/.agent/workflows/feature-development.md +0 -355
  321. package/.agent/workflows/git-workflow.md +0 -702
  322. package/.agent/workflows/multi-repo-workspace.md +0 -268
  323. package/.agent/workflows/plans.md +0 -709
  324. package/.agent/workflows/postflight.md +0 -604
  325. package/.agent/workflows/pr.md +0 -571
  326. package/.agent/workflows/preflight.md +0 -278
  327. package/.agent/workflows/ralph-loop.md +0 -773
  328. package/.agent/workflows/release.md +0 -498
  329. package/.agent/workflows/session-manager.md +0 -254
  330. package/.agent/workflows/session-review.md +0 -311
  331. package/.agent/workflows/sql-migrations.md +0 -631
  332. package/.agent/workflows/version-bump.md +0 -283
  333. package/.agent/workflows/wiki-update.md +0 -333
  334. package/.agent/workflows/worktree.md +0 -477
@@ -1,422 +0,0 @@
1
- ---
2
- description: Crawl4AI MCP server integration setup
3
- mode: subagent
4
- tools:
5
- read: true
6
- write: true
7
- edit: true
8
- bash: true
9
- glob: true
10
- grep: true
11
- webfetch: true
12
- task: true
13
- ---
14
-
15
- # Crawl4AI Integration Guide
16
-
17
- <!-- AI-CONTEXT-START -->
18
-
19
- ## Quick Reference
20
-
21
- - Crawl4AI: #1 trending open-source web crawler for AI/LLM applications
22
- - Install: `./.agent/scripts/crawl4ai-helper.sh install`
23
- - Docker setup: `./.agent/scripts/crawl4ai-helper.sh docker-setup`
24
- - Start: `./.agent/scripts/crawl4ai-helper.sh docker-start`
25
- - MCP setup: `./.agent/scripts/crawl4ai-helper.sh mcp-setup`
26
- - URLs: Dashboard http://localhost:11235/dashboard, Playground /playground, API :11235
27
- - Crawl: `./.agent/scripts/crawl4ai-helper.sh crawl URL markdown output.json`
28
- - Extract: `./.agent/scripts/crawl4ai-helper.sh extract URL '{"schema"}' data.json`
29
- - Features: LLM-ready markdown, CSS/XPath/LLM extraction, async parallel crawling
30
- - MCP tools: crawl_url, crawl_multiple, extract_structured, take_screenshot, generate_pdf
31
- - Config: `configs/crawl4ai-config.json.txt`, `configs/mcp-templates/crawl4ai-mcp-config.json`
32
- - Debug: `./.agent/scripts/crawl4ai-helper.sh status`, `docker logs crawl4ai`
33
- <!-- AI-CONTEXT-END -->
34
-
35
- ## Overview
36
-
37
- Crawl4AI is the #1 trending open-source web crawler on GitHub, specifically designed for AI and LLM applications. This integration provides comprehensive web crawling and data extraction capabilities for the AI DevOps Framework.
38
-
39
- ### Key Features
40
-
41
- - **LLM-Ready Output**: Clean markdown generation perfect for RAG pipelines
42
- - **Structured Extraction**: CSS selectors, XPath, and LLM-based data extraction
43
- - **Advanced Browser Control**: Hooks, proxies, stealth modes, session management
44
- - **High Performance**: Parallel crawling, async operations, real-time processing
45
- - **AI Integration**: Native MCP support for AI assistants like Claude
46
- - **Enterprise Features**: Monitoring dashboard, job queues, webhook notifications
47
-
48
- ## 🛠️ Installation & Setup
49
-
50
- ### Quick Start
51
-
52
- ```bash
53
- # Install Python package
54
- ./.agent/scripts/crawl4ai-helper.sh install
55
-
56
- # Setup Docker deployment
57
- ./.agent/scripts/crawl4ai-helper.sh docker-setup
58
-
59
- # Start Docker container with monitoring dashboard
60
- ./.agent/scripts/crawl4ai-helper.sh docker-start
61
-
62
- # Setup MCP integration for AI assistants
63
- ./.agent/scripts/crawl4ai-helper.sh mcp-setup
64
- ```
65
-
66
- ### Docker Deployment
67
-
68
- The Docker deployment includes:
69
-
70
- - **Real-time Monitoring Dashboard**: http://localhost:11235/dashboard
71
- - **Interactive Playground**: http://localhost:11235/playground
72
- - **REST API**: http://localhost:11235
73
- - **WebSocket Streaming**: Real-time crawl results
74
- - **Job Queue System**: Asynchronous processing with webhooks
75
-
76
- ### MCP Integration
77
-
78
- Crawl4AI provides native MCP (Model Context Protocol) support for AI assistants:
79
-
80
- ```json
81
- {
82
- "crawl4ai": {
83
- "command": "npx",
84
- "args": ["crawl4ai-mcp-server@latest"],
85
- "env": {
86
- "CRAWL4AI_API_URL": "http://localhost:11235"
87
- }
88
- }
89
- }
90
- ```
91
-
92
- ## 🎯 Core Capabilities
93
-
94
- ### 1. Web Crawling
95
-
96
- ```bash
97
- # Basic crawling
98
- ./.agent/scripts/crawl4ai-helper.sh crawl https://example.com markdown output.json
99
-
100
- # With structured extraction
101
- ./.agent/scripts/crawl4ai-helper.sh extract https://example.com '{"title":"h1","content":".article"}' data.json
102
- ```
103
-
104
- ### 2. LLM-Powered Extraction
105
-
106
- ```python
107
- import asyncio
108
- from crawl4ai import AsyncWebCrawler, LLMExtractionStrategy, LLMConfig
109
-
110
- async def extract_with_llm():
111
- async with AsyncWebCrawler() as crawler:
112
- result = await crawler.arun(
113
- url="https://example.com",
114
- extraction_strategy=LLMExtractionStrategy(
115
- llm_config=LLMConfig(provider="openai/gpt-4o"),
116
- instruction="Extract key information and summarize"
117
- )
118
- )
119
- return result.extracted_content
120
- ```
121
-
122
- ### 3. Advanced Browser Control
123
-
124
- ```python
125
- # Custom hooks for advanced control
126
- async def setup_hook(page, context, **kwargs):
127
- # Block images for faster crawling
128
- await context.route("**/*.{png,jpg,gif}", lambda r: r.abort())
129
- # Set custom viewport
130
- await page.set_viewport_size({"width": 1920, "height": 1080})
131
- return page
132
-
133
- result = await crawler.arun(
134
- url="https://example.com",
135
- hooks={"on_page_context_created": setup_hook}
136
- )
137
- ```
138
-
139
- ### 4. Adaptive Crawling
140
-
141
- ```python
142
- from crawl4ai import AdaptiveCrawler, AdaptiveConfig
143
-
144
- config = AdaptiveConfig(
145
- confidence_threshold=0.7,
146
- max_depth=5,
147
- max_pages=20,
148
- strategy="statistical"
149
- )
150
-
151
- adaptive_crawler = AdaptiveCrawler(crawler, config)
152
- state = await adaptive_crawler.digest(
153
- start_url="https://news.example.com",
154
- query="latest technology news"
155
- )
156
- ```
157
-
158
- ## 🔧 Configuration
159
-
160
- ### Environment Variables
161
-
162
- ```bash
163
- # LLM Provider Configuration
164
- OPENAI_API_KEY=sk-your-key
165
- ANTHROPIC_API_KEY=your-anthropic-key
166
- LLM_PROVIDER=openai/gpt-4o-mini
167
- LLM_TEMPERATURE=0.7
168
-
169
- # Crawl4AI Settings
170
- CRAWL4AI_MAX_PAGES=50
171
- CRAWL4AI_TIMEOUT=60
172
- CRAWL4AI_DEFAULT_FORMAT=markdown
173
- ```
174
-
175
- ### Browser Configuration
176
-
177
- ```python
178
- browser_config = BrowserConfig(
179
- headless=True,
180
- viewport={"width": 1920, "height": 1080},
181
- user_agent="Mozilla/5.0 (compatible; Crawl4AI/0.7.7)",
182
- timeout=30000,
183
- extra_args=["--disable-blink-features=AutomationControlled"]
184
- )
185
- ```
186
-
187
- ### Crawler Configuration
188
-
189
- ```python
190
- crawler_config = CrawlerRunConfig(
191
- cache_mode=CacheMode.ENABLED,
192
- max_depth=3,
193
- delay_between_requests=1.0,
194
- respect_robots_txt=True,
195
- follow_redirects=True,
196
- extraction_strategy=JsonCssExtractionStrategy(schema=your_schema)
197
- )
198
- ```
199
-
200
- ## 📊 Monitoring & Analytics
201
-
202
- ### Dashboard Features
203
-
204
- - **Real-time Metrics**: System health, memory usage, request tracking
205
- - **Browser Pool Management**: Active/hot/cold browser instances
206
- - **Request Analytics**: Success rates, response times, error tracking
207
- - **Resource Monitoring**: CPU, memory, network utilization
208
-
209
- ### API Endpoints
210
-
211
- ```bash
212
- # Health check
213
- curl http://localhost:11235/health
214
-
215
- # Prometheus metrics
216
- curl http://localhost:11235/metrics
217
-
218
- # API schema
219
- curl http://localhost:11235/schema
220
- ```
221
-
222
- ## 🔄 Job Queue & Webhooks
223
-
224
- ### Asynchronous Processing
225
-
226
- ```python
227
- # Submit crawl job
228
- response = requests.post("http://localhost:11235/crawl/job", json={
229
- "urls": ["https://example.com"],
230
- "webhook_config": {
231
- "webhook_url": "https://your-app.com/webhook",
232
- "webhook_data_in_payload": True
233
- }
234
- })
235
-
236
- task_id = response.json()["task_id"]
237
- ```
238
-
239
- ### Webhook Notifications
240
-
241
- ```python
242
- @app.route('/webhook', methods=['POST'])
243
- def handle_webhook():
244
- payload = request.json
245
- if payload['status'] == 'completed':
246
- process_results(payload['data'])
247
- return "OK", 200
248
- ```
249
-
250
- ## 🤖 AI Assistant Integration
251
-
252
- ### Claude Desktop Setup
253
-
254
- Add to your Claude Desktop MCP configuration:
255
-
256
- ```json
257
- {
258
- "mcpServers": {
259
- "crawl4ai": {
260
- "command": "npx",
261
- "args": ["crawl4ai-mcp-server@latest"]
262
- }
263
- }
264
- }
265
- ```
266
-
267
- ### Available MCP Tools
268
-
269
- - `crawl_url`: Crawl single URL with format options
270
- - `crawl_multiple`: Batch crawl multiple URLs
271
- - `extract_structured`: Extract data using CSS or LLM
272
- - `take_screenshot`: Capture webpage screenshots
273
- - `generate_pdf`: Convert webpages to PDF
274
- - `execute_javascript`: Run custom JavaScript on pages
275
-
276
- ## 🔒 Security & Best Practices
277
-
278
- ### Rate Limiting
279
-
280
- ```yaml
281
- rate_limiting:
282
- enabled: true
283
- default_limit: "1000/minute"
284
- trusted_proxies: []
285
- ```
286
-
287
- ### Security Headers
288
-
289
- ```yaml
290
- security:
291
- headers:
292
- x_content_type_options: "nosniff"
293
- x_frame_options: "DENY"
294
- content_security_policy: "default-src 'self'"
295
- ```
296
-
297
- ### Hook Security
298
-
299
- - Never trust user-provided hook code
300
- - Validate and sandbox hook execution
301
- - Use timeouts to prevent infinite loops
302
- - Audit hook code before deployment
303
-
304
- ## 📚 Use Cases
305
-
306
- ### 1. Content Aggregation
307
-
308
- ```python
309
- # News aggregation
310
- urls = ["https://news1.com", "https://news2.com", "https://news3.com"]
311
- results = await crawler.arun_many(urls, extraction_strategy=news_schema)
312
- ```
313
-
314
- ### 2. E-commerce Data
315
-
316
- ```python
317
- # Product information extraction
318
- product_schema = {
319
- "name": "h1.product-title",
320
- "price": ".price",
321
- "description": ".product-description",
322
- "images": {"selector": "img.product-image", "type": "attribute", "attribute": "src"}
323
- }
324
- ```
325
-
326
- ### 3. Research & Analysis
327
-
328
- ```python
329
- # Academic paper extraction
330
- paper_extraction = LLMExtractionStrategy(
331
- instruction="Extract title, authors, abstract, and key findings",
332
- schema=paper_schema
333
- )
334
- ```
335
-
336
- ### 4. SEO & Marketing
337
-
338
- ```python
339
- # SEO data extraction
340
- seo_schema = {
341
- "title": "title",
342
- "meta_description": "meta[name='description']",
343
- "headings": "h1, h2, h3",
344
- "links": {"selector": "a", "type": "attribute", "attribute": "href"}
345
- }
346
- ```
347
-
348
- ## 🚀 Advanced Features
349
-
350
- ### Virtual Scroll Support
351
-
352
- ```python
353
- scroll_config = VirtualScrollConfig(
354
- container_selector="[data-testid='feed']",
355
- scroll_count=20,
356
- scroll_by="container_height",
357
- wait_after_scroll=1.0
358
- )
359
- ```
360
-
361
- ### Session Management
362
-
363
- ```python
364
- # Persistent browser sessions
365
- browser_config = BrowserConfig(
366
- use_persistent_context=True,
367
- user_data_dir="/path/to/profile"
368
- )
369
- ```
370
-
371
- ### Proxy Support
372
-
373
- ```python
374
- # Proxy configuration
375
- browser_config = BrowserConfig(
376
- proxy={
377
- "server": "http://proxy.example.com:8080",
378
- "username": "user",
379
- "password": "pass"
380
- }
381
- )
382
- ```
383
-
384
- ## 🔧 Troubleshooting
385
-
386
- ### Common Issues
387
-
388
- 1. **Browser not starting**: Check Docker memory allocation (--shm-size=1g)
389
- 2. **API not responding**: Verify container is running and port is accessible
390
- 3. **Extraction failing**: Validate CSS selectors or LLM configuration
391
- 4. **Memory issues**: Adjust browser pool size and cleanup intervals
392
-
393
- ### Debug Commands
394
-
395
- ```bash
396
- # Check service status
397
- ./.agent/scripts/crawl4ai-helper.sh status
398
-
399
- # View container logs
400
- docker logs crawl4ai
401
-
402
- # Test API health
403
- curl http://localhost:11235/health
404
- ```
405
-
406
- ## 📖 Resources
407
-
408
- - **Official Documentation**: https://docs.crawl4ai.com/
409
- - **GitHub Repository**: https://github.com/unclecode/crawl4ai
410
- - **Framework Integration**: `.agent/scripts/crawl4ai-helper.sh`
411
- - **Configuration Templates**: `configs/crawl4ai-config.json.txt`
412
- - **MCP Configuration**: `configs/mcp-templates/crawl4ai-mcp-config.json`
413
-
414
- ## 🎯 Next Steps
415
-
416
- 1. **Install and Setup**: Run the helper script to get started
417
- 2. **Explore Dashboard**: Visit http://localhost:11235/dashboard
418
- 3. **Try Playground**: Test crawling at http://localhost:11235/playground
419
- 4. **Setup MCP**: Integrate with your AI assistant
420
- 5. **Build Applications**: Use the API for your specific use cases
421
-
422
- Crawl4AI transforms web data into AI-ready formats, making it perfect for RAG systems, data pipelines, and AI-powered applications.
@@ -1,277 +0,0 @@
1
- ---
2
- description: Crawl4AI documentation and resource links
3
- mode: subagent
4
- tools:
5
- read: true
6
- write: false
7
- edit: false
8
- bash: false
9
- glob: true
10
- grep: true
11
- webfetch: true
12
- task: true
13
- ---
14
-
15
- # Crawl4AI Resources & Links
16
-
17
- <!-- AI-CONTEXT-START -->
18
-
19
- ## Quick Reference
20
-
21
- - **Docs**: https://docs.crawl4ai.com/
22
- - **GitHub**: https://github.com/unclecode/crawl4ai
23
- - **Docker**: `unclecode/crawl4ai:latest`
24
- - **PyPI**: https://pypi.org/project/crawl4ai/
25
- - **MCP NPM**: `npx crawl4ai-mcp-server@latest`
26
- - **Discord**: https://discord.gg/jP8KfhDhyN
27
- - **CapSolver**: https://www.capsolver.com/ (CAPTCHA integration)
28
- - **API Endpoints**: `/crawl`, `/crawl/job`, `/health`, `/metrics`, `/screenshot`, `/pdf`
29
- - **Framework Files**: `.agent/scripts/crawl4ai-helper.sh`, `configs/crawl4ai-config.json.txt`
30
- - **Current Version**: v0.7.7 (November 2024)
31
- <!-- AI-CONTEXT-END -->
32
-
33
- ## Official Resources
34
-
35
- ### Primary Documentation
36
-
37
- - **Official Documentation**: https://docs.crawl4ai.com/
38
- - **GitHub Repository**: https://github.com/unclecode/crawl4ai
39
- - **Docker Hub**: https://hub.docker.com/r/unclecode/crawl4ai
40
- - **PyPI Package**: https://pypi.org/project/crawl4ai/
41
-
42
- ### Community & Support
43
-
44
- - **Discord Community**: https://discord.gg/jP8KfhDhyN
45
- - **GitHub Issues**: https://github.com/unclecode/crawl4ai/issues
46
- - **GitHub Discussions**: https://github.com/unclecode/crawl4ai/discussions
47
- - **Changelog**: https://github.com/unclecode/crawl4ai/blob/main/CHANGELOG.md
48
-
49
- ### CapSolver Integration
50
-
51
- - **CapSolver Homepage**: https://www.capsolver.com/
52
- - **CapSolver Dashboard**: https://dashboard.capsolver.com/dashboard/overview
53
- - **CapSolver Documentation**: https://docs.capsolver.com/
54
- - **Crawl4AI Partnership**: https://www.capsolver.com/blog/Partners/crawl4ai-capsolver/
55
- - **Chrome Extension**: https://chrome.google.com/webstore/detail/capsolver/pgojnojmmhpofjgdmaebadhbocahppod
56
-
57
- ## Documentation Sections
58
-
59
- ### Core Documentation
60
-
61
- - **Quick Start**: https://docs.crawl4ai.com/quick-start/
62
- - **Installation**: https://docs.crawl4ai.com/setup-installation/installation/
63
- - **Docker Deployment**: https://docs.crawl4ai.com/setup-installation/docker-deployment/
64
- - **API Reference**: https://docs.crawl4ai.com/api-reference/
65
-
66
- ### Advanced Features
67
-
68
- - **Adaptive Crawling**: https://docs.crawl4ai.com/advanced/adaptive-strategies/
69
- - **Virtual Scroll**: https://docs.crawl4ai.com/advanced/virtual-scroll/
70
- - **Hooks & Authentication**: https://docs.crawl4ai.com/advanced/hooks-auth/
71
- - **Session Management**: https://docs.crawl4ai.com/advanced/session-management/
72
-
73
- ### Extraction Strategies
74
-
75
- - **LLM-Free Strategies**: https://docs.crawl4ai.com/extraction/llm-free-strategies/
76
- - **LLM Strategies**: https://docs.crawl4ai.com/extraction/llm-strategies/
77
- - **Clustering Strategies**: https://docs.crawl4ai.com/extraction/clustering-strategies/
78
- - **Chunking**: https://docs.crawl4ai.com/extraction/chunking/
79
-
80
- ## Framework Integration
81
-
82
- ### Helper Scripts
83
-
84
- - **Main Helper**: `.agent/scripts/crawl4ai-helper.sh`
85
- - **Examples Script**: `.agent/scripts/crawl4ai-examples.sh`
86
- - **Configuration Template**: `configs/crawl4ai-config.json.txt`
87
- - **MCP Configuration**: `configs/mcp-templates/crawl4ai-mcp-config.json`
88
-
89
- ### Documentation Files
90
-
91
- - **Main Guide**: `.agent/crawl4ai.md`
92
- - **Integration Guide**: `.agent/wiki/crawl4ai-integration.md`
93
- - **Usage Guide**: `.agent/spec/crawl4ai-usage.md`
94
- - **Resources**: `.agent/links/crawl4ai-resources.md` (this file)
95
-
96
- ## MCP Integration
97
-
98
- ### MCP Server
99
-
100
- - **NPM Package**: https://www.npmjs.com/package/crawl4ai-mcp-server
101
- - **Installation**: `npx crawl4ai-mcp-server@latest`
102
- - **Documentation**: https://docs.crawl4ai.com/core/docker-deployment/#mcp-model-context-protocol-support
103
-
104
- ### Claude Desktop Integration
105
-
106
- ```json
107
- {
108
- "mcpServers": {
109
- "crawl4ai": {
110
- "command": "npx",
111
- "args": ["crawl4ai-mcp-server@latest"]
112
- }
113
- }
114
- }
115
- ```
116
-
117
- ## Docker Resources
118
-
119
- ### Docker Images
120
-
121
- - **Latest Release**: `unclecode/crawl4ai:latest`
122
- - **Specific Version**: `unclecode/crawl4ai:0.7.7`
123
- - **Multi-Architecture**: Supports AMD64 and ARM64
124
-
125
- ### Docker Compose
126
-
127
- - **Example Compose**: https://github.com/unclecode/crawl4ai/blob/main/docker-compose.yml
128
- - **Environment Variables**: https://docs.crawl4ai.com/core/docker-deployment/#environment-setup-api-keys
129
-
130
- ## Use Case Examples
131
-
132
- ### Content Research
133
-
134
- - **News Aggregation**: Extract articles from multiple news sources
135
- - **Academic Papers**: Extract titles, authors, abstracts, and citations
136
- - **Documentation**: Process API docs and technical documentation
137
-
138
- ### E-commerce Data
139
-
140
- - **Product Information**: Extract names, prices, descriptions, specifications
141
- - **Inventory Tracking**: Monitor stock levels and price changes
142
- - **Competitor Analysis**: Compare products across different sites
143
-
144
- ### SEO & Marketing
145
-
146
- - **Content Analysis**: Extract headings, meta tags, and content structure
147
- - **Link Analysis**: Discover internal and external link patterns
148
- - **Performance Monitoring**: Track page changes and updates
149
-
150
- ## API Endpoints
151
-
152
- ### Core Endpoints
153
-
154
- - **Crawl**: `POST /crawl` - Synchronous crawling
155
- - **Crawl Job**: `POST /crawl/job` - Asynchronous crawling with webhooks
156
- - **LLM Job**: `POST /llm/job` - LLM extraction with webhooks
157
- - **Job Status**: `GET /job/{task_id}` - Check job status
158
-
159
- ### Utility Endpoints
160
-
161
- - **Health**: `GET /health` - Service health check
162
- - **Metrics**: `GET /metrics` - Prometheus metrics
163
- - **Schema**: `GET /schema` - API schema documentation
164
- - **Dashboard**: `GET /dashboard` - Monitoring dashboard
165
- - **Playground**: `GET /playground` - Interactive testing interface
166
-
167
- ### Media Endpoints
168
-
169
- - **Screenshot**: `POST /screenshot` - Capture page screenshots
170
- - **PDF**: `POST /pdf` - Generate PDF from webpage
171
- - **HTML**: `POST /html` - Extract raw HTML
172
- - **JavaScript**: `POST /js` - Execute JavaScript on page
173
-
174
- ## Security Resources
175
-
176
- ### Best Practices
177
-
178
- - **Rate Limiting**: Built-in protection against abuse
179
- - **User Agent**: Clear identification as Crawl4AI
180
- - **Robots.txt**: Respects robots.txt by default
181
- - **Timeout Protection**: Prevents hanging requests
182
-
183
- ### Authentication
184
-
185
- - **JWT Support**: Optional JWT authentication for API access
186
- - **API Keys**: Secure API key management for LLM providers
187
- - **Webhook Security**: Custom headers for webhook authentication
188
-
189
- ## Monitoring & Analytics
190
-
191
- ### Dashboard Features
192
-
193
- - **System Metrics**: CPU, memory, network utilization
194
- - **Request Analytics**: Success rates, response times, error tracking
195
- - **Browser Pool**: Active/hot/cold browser instances management
196
- - **Job Queue**: Real-time job processing status
197
-
198
- ### Metrics Integration
199
-
200
- - **Prometheus**: Native Prometheus metrics export
201
- - **Health Checks**: Comprehensive health monitoring
202
- - **Performance Tracking**: Request timing and resource usage
203
-
204
- ## Performance Optimization
205
-
206
- ### Configuration Tips
207
-
208
- - **Browser Pool Size**: Optimize based on available resources
209
- - **Concurrent Requests**: Balance speed vs resource usage
210
- - **Memory Management**: Configure cleanup intervals and thresholds
211
- - **Caching**: Use appropriate cache modes for your use case
212
-
213
- ### Resource Management
214
-
215
- - **Docker Memory**: Allocate sufficient shared memory (--shm-size=1g)
216
- - **CPU Throttling**: Configure CPU limits for container
217
- - **Network Optimization**: Use appropriate timeouts and retry policies
218
-
219
- ## Version Information
220
-
221
- ### Current Version
222
-
223
- - **Latest Stable**: v0.7.7
224
- - **Release Date**: November 2024
225
- - **Breaking Changes**: Check CHANGELOG.md for migration notes
226
-
227
- ### Version History
228
-
229
- - **v0.7.7**: Self-hosting platform with real-time monitoring
230
- - **v0.7.6**: Complete webhook infrastructure for job queue API
231
- - **v0.7.5**: Docker hooks system with function-based API
232
- - **v0.7.4**: Intelligent table extraction & performance updates
233
-
234
- ## Learning Resources
235
-
236
- ### Tutorials & Guides
237
-
238
- - **Video Tutorial**: Available on documentation homepage
239
- - **Code Examples**: https://github.com/unclecode/crawl4ai/tree/main/.agent/examples
240
- - **Blog Posts**: Check GitHub discussions for community tutorials
241
-
242
- ### Community Examples
243
-
244
- - **GitHub Examples**: Real-world usage examples in repository
245
- - **Discord Discussions**: Community-shared patterns and solutions
246
- - **Stack Overflow**: Tagged questions and answers
247
-
248
- ## Contributing
249
-
250
- ### Development
251
-
252
- - **Contributing Guide**: https://github.com/unclecode/crawl4ai/blob/main/CONTRIBUTING.md
253
- - **Code of Conduct**: https://github.com/unclecode/crawl4ai/blob/main/CODE_OF_CONDUCT.md
254
- - **Development Setup**: Local development instructions in README
255
-
256
- ### Sponsorship
257
-
258
- - **GitHub Sponsors**: Support the project development
259
- - **Enterprise Support**: Commercial support options available
260
- - **Community Recognition**: Contributors acknowledged in project
261
-
262
- ## Support Channels
263
-
264
- ### Technical Support
265
-
266
- 1. **GitHub Issues**: Bug reports and feature requests
267
- 2. **Discord Community**: Real-time community support
268
- 3. **Documentation**: Comprehensive guides and API reference
269
- 4. **Stack Overflow**: Tag questions with `crawl4ai`
270
-
271
- ### Enterprise Support
272
-
273
- - **Commercial Licensing**: Available for enterprise use
274
- - **Priority Support**: Dedicated support channels
275
- - **Custom Development**: Tailored solutions and integrations
276
-
277
- This resource collection provides comprehensive access to all Crawl4AI documentation, tools, and community resources for effective integration within the AI DevOps Framework.