Welcome to the CrawlLama documentation! This guide organizes all tutorials, references, and guides into clear categories for easier navigation.
First steps with CrawlLama:
- INSTALLATION.md – Detailed installation guide
- QUICKSTART.md – Quick start in 5 minutes
- CONFIG_SETUP.md – Configuration file setup and usage
- ADAPTIVE_HOPS_QUICKSTART.md – Adaptive Hops quick start
Feature-specific guides:
- LANGGRAPH_GUIDE.md – Multi-hop reasoning with LangGraph
- PLUGIN_TUTORIAL.md – Developing and using plugins
- SEARCH_LIMITATIONS.md – Web search limitations
- HALLUCINATION_DETECTION.md – Hallucination detection
- RAG_ANALYSIS.md – RAG implementation and architecture
- API_USAGE.md – API usage guide
- EXPORT_REPORT.md – Export generated reports as Markdown or plain text
- ARENA.md – Model arena & regression harness (
python -m arena)
Open Source Intelligence Module:
- OSINT_USAGE.md – OSINT modules (Email, Phone, Advanced Operators)
- PHONE_INTELLIGENCE.md – Phone intelligence developer documentation (parsing, normalization, auto-detection)
- OSINT_CONTEXT_USAGE.md – OSINT in context
- SOCIAL_INTELLIGENCE.md – Social intelligence features
System monitoring and dashboard:
- HEALTH_MONITORING.md – Health monitoring
- HEALTH_DASHBOARD.md – Dashboard usage
- HEALTH_FEATURES.md – Available features
- DASHBOARD_STARTER.md – Starting the dashboard
- ADAPTIVE_HOPS.md – Intelligent agent selection and complexity management
- PROJECT_STRUCTURE.md – Project structure overview
- 1.4.11-doc-audit-code-findings.md – Open code findings from the v1.4.11 documentation audit
- bugs/delete_null_file.md – Bug examples
- SECRET_LEAK_RESPONSE.md – Secret leak response and incident plan
- README.md – Main project documentation
- CONTRIBUTING.md – How to contribute
- CODE_OF_CONDUCT.md – Community code of conduct
- SECURITY.md – Report vulnerabilities
- CHANGELOG.md – Release history
docs/
├── README.md
├── getting-started/
│ ├── INSTALLATION.md
│ ├── QUICKSTART.md
│ ├── CONFIG_SETUP.md
│ └── ADAPTIVE_HOPS_QUICKSTART.md
├── guides/
│ ├── LANGGRAPH_GUIDE.md
│ ├── PLUGIN_TUTORIAL.md
│ ├── SEARCH_LIMITATIONS.md
│ ├── SEARCH_IMPROVEMENTS.md
│ ├── HALLUCINATION_DETECTION.md
│ ├── RAG_ANALYSIS.md
│ ├── API_USAGE.md
│ ├── ADAPTIVE_HOPS.md
│ ├── CLI_PROVIDER_SELECTION.md
│ ├── CLOUD_LLM_INTEGRATION.md
│ └── EXPORT_REPORT.md
├── osint/
│ ├── OSINT_USAGE.md
│ ├── PHONE_INTELLIGENCE.md
│ ├── OSINT_CONTEXT_USAGE.md
│ ├── SOCIAL_INTELLIGENCE.md
│ └── COMPANY_INTELLIGENCE.md
├── health/
│ ├── HEALTH_MONITORING.md
│ ├── HEALTH_DASHBOARD.md
│ ├── HEALTH_FEATURES.md
│ └── DASHBOARD_STARTER.md
├── development/
│ ├── PROJECT_STRUCTURE.md
│ ├── 1.4.7-Breachdata-update-plan.md
│ ├── 1.4.11-doc-audit-code-findings.md
│ └── bugs/
│ └── delete_null_file.md
└── security/
├── SECRET_LEAK_RESPONSE.md
├── api-security-guide.md
├── 1.4.7-security_analysis_report.md
└── CODEQL_Sec-Volun-test.txt
- config.json – Main configuration
- .env.example – Environment variables template
- pytest.ini – Test configuration
- GitHub Repository: github.com/arn-c0de/Crawllama
- Issues: github.com/arn-c0de/Crawllama/issues
- Security Advisories: github.com/arn-c0de/Crawllama/security
- README.md – Project overview
- INSTALLATION.md – Detailed installation
- QUICKSTART.md – Quick start
- LANGGRAPH_GUIDE.md – Multi-hop reasoning
- PLUGIN_TUTORIAL.md – Plugin system
- EXPORT_REPORT.md – Export reports to file
- HEALTH_MONITORING.md – Health dashboard
- OSINT_USAGE.md – OSINT features
- PHONE_INTELLIGENCE.md – Phone intelligence internals
- HALLUCINATION_DETECTION.md – Quality control
- SEARCH_LIMITATIONS.md – Search limitations
- CONTRIBUTING.md – Contribution guidelines
- SECRET_LEAK_RESPONSE.md – Incident response
- Found a bug? → Bug Report
- Feature request? → Feature Request
- Documentation issue? → Documentation Issue
Back to Main Page | License | Contributing | RAG Analysis