curllm

curllm Documentation

Welcome to the curllm documentation! This directory contains comprehensive guides, tutorials, and reference materials.

📖 Quick Navigation

Start here: Documentation Index (INDEX.md)

Popular Pages

• Installation Guide - Get curllm up and running
• Examples - Practical use cases and code samples
• Hierarchical Planner - 87% token reduction with intelligent planning
• Form Filling - Automated form completion
• API Reference - REST API endpoints
• Environment Variables - Configuration options
• Troubleshooting - Common issues and solutions

🗂️ Documentation Structure

docs/
├── INDEX.md                     # Main documentation index
├── Installation.md              # Installation instructions
├── EXAMPLES.md                  # Practical examples
├── HIERARCHICAL_PLANNER.md      # LLM optimization guide (NEW!)
├── FORM_FILLING.md              # Form automation guide (NEW!)
├── API.md                       # REST API reference
├── Environment.md               # Configuration guide
├── Playwright_BQL.md            # Browser Query Language
├── DIFFING.md                   # Content diffing system
├── REMOTE_PROXY_TUTORIAL.md     # Proxy setup
├── Docker.md                    # Docker deployment
├── Devbox.md                    # Development environment
├── Troubleshooting.md           # Common issues
└── TODO_DETAILED.md             # Development roadmap

🆕 Recent Additions

November 2024

• Hierarchical Planner - Revolutionary 3-level LLM optimization
  • 87% reduction in token usage
  • Interactive detail requesting
  • Automatic threshold-based activation
• Form Filling Guide - Complete form automation documentation
  • Priority-based value handling
  • Automatic error detection
  • Email validation fallbacks

🔗 External Links

• Main Project README
• GitHub Repository
• TODO List
• CHANGELOG

📝 Contributing to Documentation

Documentation improvements are welcome! To contribute:

1. Edit the relevant .md file in docs/
2. Ensure navigation links are maintained
3. Test all internal links
4. Submit a pull request

Documentation Standards

• Navigation: Every page should have header and footer navigation
• Formatting: Use clear headings, code blocks, and examples
• Links: Always use relative links for internal documentation
• Examples: Include practical, runnable code samples

💡 Tips

• Use browser’s search (Ctrl+F / Cmd+F) to find topics quickly
• Check the INDEX for a complete documentation map
• Start with Examples if you learn by doing
• Refer to Troubleshooting when encountering issues

---

📚 Documentation Index

⬆️ Back to Top

Main README

This site is open source. Improve this page.