1bac5e0dba
The README had grown to ~1050 lines covering everything from vim
keybindings to crates.io publishing. Following the sympozium pattern:
the README keeps the hook (banner, install, quickstart, short how-it-
works) at ~190 lines, and deep content moves verbatim to focused
guides under docs/ (tui, cli, how-it-works, providers, platform
support, custom models, development, openclaw), linked from the
Documentation matrix at the top.
Also removes the stale /docs entry from .gitignore (added in 7f35522
with no generator behind it — nothing in CI or the web build writes
to /docs).
All relative links and anchors validated programmatically; root-
relative links in moved content rewritten with ../. README.zh.md and
README.ja.md are intentionally untouched until the English layout
settles.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2.1 KiB
Custom Models
Add your own models locally without a rebuild, or contribute a model to the built-in catalog.
Adding your own models locally (no rebuild needed)
You don't need to modify llmfit or wait for a release to see extra models. Create a custom_models.json in llmfit's data directory:
- Linux:
~/.local/share/llmfit/custom_models.json - macOS:
~/Library/Application Support/llmfit/custom_models.json - Windows:
%APPDATA%\llmfit\custom_models.json
(or point the LLMFIT_CUSTOM_MODELS env var at any path). The file is a JSON array using the same entry format as the built-in catalog — see llmfit-core/data/schema.json; only a few fields are required:
[
{
"name": "my-org/My-Model-7B",
"provider": "my-org",
"parameter_count": "7B",
"min_ram_gb": 5.0,
"recommended_ram_gb": 8.0,
"min_vram_gb": 5.0,
"quantization": "Q4_K_M",
"context_length": 32768,
"use_case": "General chat"
}
]
Custom entries with the same name as a catalog model override it; new names are added. Optional fields (is_moe, num_hidden_layers, gguf_sources, …) improve estimate accuracy when provided. You can also run llmfit update to fetch trending models from HuggingFace without a rebuild.
Adding a model to the built-in catalog
- Add the model's HuggingFace repo ID (e.g.,
meta-llama/Llama-3.1-8B) to theTARGET_MODELSlist inscripts/scrape_hf_models.py. - If the model is gated (requires HuggingFace authentication to access metadata), add a fallback entry to the
FALLBACKSlist in the same script with the parameter count and context length. - Run the automated update script:
make update-models # or: ./scripts/update_models.sh - Verify the updated model list:
./target/release/llmfit list - Update MODELS.md by running:
python3 << 'EOF' < scripts/...(see commit history for the generator script) - Open a pull request.
See MODELS.md for the current list and AGENTS.md for architecture details.