openclaw/extensions/llama-cpp/README.md
Peter Steinberger edecdbd05e
refactor(config): config-surface reduction tranche 3 — product consolidations (review request) (#111527)
* refactor(config): consolidate media model lists

* refactor(config): unify memory configuration

* refactor(config): consolidate TTS ownership

* refactor(config): move typing policy to agents

* refactor(config): retire product-level config surfaces

* refactor(config): share scoped tool policy type

* chore(config): refresh generated baselines

* fix(config): honor agent typing overrides

* fix(config): migrate sibling config consumers

* refactor(infra): keep base64url decoder private

* fix(config): strip invalid legacy TTS values

* chore(config): refresh rebased baseline hash

* fix(doctor): route legacy messages.tts.realtime voice to talk during tts move

* refactor(config): polish final layout names

* refactor(config): freeze retired tuning defaults

* feat(config): add fast mode default symmetry

* refactor(config): key agent entries by id

* docs(config): update final layout reference

* test(config): cover final layout migrations

* chore(config): refresh final layout baselines

* fix(config): align final layout runtime readers

* fix(config): align remaining readers

* fix(config): stabilize final layout migrations

* fix(config): finalize config projection proof

* fix(config): address final layout review

* docs(release): preserve historical config names

* fix(config): complete keyed agent migration

* fix(config): close final migration gaps

* fix(config): finish full-branch review

* fix(config): complete runtime secret detection

* fix(config): close final review findings

* fix(config): finish canonical docs and heartbeat migration

* fix(config): integrate latest main after rebase

* refactor(env): isolate test-only controls

* refactor(env): isolate build and development controls

* refactor(env): collapse process identity indirection

* refactor(env): remove duplicate config and temp aliases

* docs(env): define the operator-facing allowlist

* ci(env): ratchet production variable count

* fix(env): remove stale provider helper import

* fix(env): make ratchet sorting explicit

* test(env): keep test seam in dead-code audit

* test(env): cover ratchet growth and boundary; document surface budgets

* docs(config): document tier-eval consolidations

* docs(config): clarify speech preference ownership

* test(memory): align retired tuning fixtures

* refactor(memory): freeze engine heuristics

* refactor(config): apply tier-eval tranche

* refactor(tts): move persona shaping to providers

* refactor(compaction): move prompt policy to providers

* test(config): align hookified prompt fixtures

* chore(deadcode): classify test-only exports

* chore(github): remove unused spawn helper

* chore(deadcode): classify queue diagnostics

* chore(deadcode): remove unused lane snapshot export

* chore(plugin-sdk): ratchet consolidated surface

* fix(config): integrate latest main after rebase
2026-07-21 20:28:43 -07:00

1.4 KiB

@openclaw/llama-cpp-provider

Official llama.cpp text-inference and embedding provider for OpenClaw.

This plugin runs local GGUF chat and embedding models in-process through node-llama-cpp.

Install

openclaw plugins install @openclaw/llama-cpp-provider

Restart the Gateway after installing or updating the plugin. Use Node 24 for native installs and updates.

Configure text inference

Choose Local model (llama.cpp) during onboarding. After explicit consent, OpenClaw downloads Gemma 4 E4B IT Q4_K_M (approximately 5.0 GB) as the default. The bundled download is offered only on machines with at least 16 GiB of RAM. Discovery never downloads a model.

On smaller machines, use Ollama or LM Studio with a smaller model, use a cloud provider, or configure any custom GGUF through params.modelPath. The 16 GiB gate applies only to OpenClaw's bundled default download; custom GGUF models remain available on any machine.

See the llama.cpp provider guide for custom GGUF model configuration and hardware guidance.

Configure embeddings

Set memory.search.provider to local. By default, the plugin downloads and uses the EmbeddingGemma GGUF model. Configure memory.search.local.modelPath to use another local path, Hugging Face model URI, or HTTPS model URL.

Package

  • Plugin id: llama-cpp
  • Package: @openclaw/llama-cpp-provider
  • Minimum OpenClaw host: 2026.6.2