LLM4Free Documentation Hub

Last updated: 2025-12-20
Maintained by LLM4Free

Welcome to the central entry point for everything you need to know about LLM4Free. This hub is organized around the actual modules that live inside the repository so you can quickly jump from high-level concepts to concrete implementation details.

📚 Complete Documentation Index →

Navigate all docs, find learning paths, search by use case, and get started quickly!

---

🔗 Quick Navigation

Topic	Why it matters	Primary Reference
Overall architecture	Understand how CLI, server, client, providers, and extras fit together	docs/architecture.md
Command line tooling	Detailed reference for every llm4free CLI command and option	docs/cli.md
Unified Python client	Auto-failover chat & image client backed by llm4free/client.py	docs/client.md
Model registry	Enumerate LLM, TTS, and TTI models exposed via llm4free/models.py	docs/models.md
OpenAI-compatible API server	Deploy FastAPI server that proxies any LLM4Free provider	docs/openai-api-server.md
Search stack	DuckDuckGo/Yep/Bing/Yahoo engines + CLI usage	docs/search.md
HTML parser & crawler	Deep dive into llm4free/scout	docs/scout.md
Stream sanitizers	Advanced SSE/HTTP stream processing utilities	docs/sanitize.md
Decorators & utilities	Retry/timing helpers from llm4free/AIutel.py	docs/decorators.md
Docker & deployment	Images, compose profiles, env vars	docs/DOCKER.md
GGUF tooling	Model conversion helpers (llm4free/Extra/gguf.py)	docs/gguf.md
Inferno local LLMs	Run local servers compatible with LLM4Free providers	docs/inferno.md
LitPrinter	Debug printing companion shipped with LLM4Free	docs/litprinter.md
LitAgent	Advanced User Agent & IP rotation toolkit	docs/litagent.md
Weather toolkit	Weather + ASCII weather helpers inside llm4free/Extra	docs/weather.md
ZeroArt ASCII generator	Zero-dependency ASCII art text generator with multiple fonts and effects	docs/zeroart.md
Provider matrix	Complete list of providers and locations	Provider.md

🧭 How to Use This Hub

1. Start with the architecture overview if you are new to the codebase or planning a big change. It explains the flow between public interfaces, search engines, providers, and helper modules.
2. Jump into topic-specific guides (CLI, client, server, search, etc.) once you know which layer you want to extend.
3. Reference module-level docs (decorators, sanitizer, scout, GGUF, etc.) for implementation details or API signatures.
4. Use the provider matrix whenever you need to locate a provider implementation quickly.

🗂️ Project Map at a Glance

• llm4free/cli.py – Rich CLI built on swiftcli with commands for DuckDuckGo, Yep, Bing, Yahoo, and weather utilities.
• llm4free/client.py – Unified chat + image client with intelligent provider/model resolution and automatic failover.
• llm4free/server/ – FastAPI-based OpenAI-compatible server (docs/openai-api-server.md covers routes, config, env vars).
• llm4free/search/ – Shared search abstractions (DuckDuckGo, Yep, Bing, Yahoo) plus result formatting helpers.
• llm4free/Provider/ – Provider implementations (normal + OpenAI-compatible) including AI search, TTI, TTS, STT, and experiments.
• llm4free/Extra/ – Auxiliary toolkits like GGUF conversion, weather clients, temp mail, Git/YouTube utilities.
• docs/ – This folder: each guide is sourced directly from the modules above so it stays true to the code.

🆕 Recently Added Docs

• Architecture Overview — visual + textual description of the runtime layers.
• CLI Reference — exhaustive explanation of llm4free command families.
• Unified Client Guide — how to leverage the Client failover logic from Python code.
• Model Registry Guide — using model.llm, model.tts, and model.tti helpers.

🙌 Contributing to Documentation

• When you add a feature, update or append the relevant topic in this hub so future contributors can find it.
• If you introduce a brand new area (e.g., a new toolkit under llm4free/Extra), create a dedicated doc and list it in the table above.
• Keep examples synchronized with the code (import paths, parameter names, defaults, and behaviors should match the actual modules).

Need something that is not documented yet? Open an issue or PR and link back to this hub so we can keep the map current.