docs: sweep READMEs + QUICKSTARTs for multi-LLM provider support#28
Merged
Conversation
PR #27 wired Anthropic / OpenAI / xAI / Gemini support into the agent runner, start.sh, frontend pages, and the new video script — but missed every README and QUICKSTART. Those are the surfaces npm displays on package landing pages, which is where most operators read first. This commit fixes that gap. Each README now shows the full four-provider matrix instead of just Anthropic: Provider | Key prefix | Default model | Get a key Anthropic | sk-ant-… | claude-sonnet-4-6 | console.anthropic.com OpenAI | sk-…/sk-proj- | gpt-5 | platform.openai.com xAI | xai-… | grok-3-latest | console.x.ai Gemini | AI… | gemini-2.5-flash | aistudio.google.com And the deploy example block shows all four `./start.sh` variants in sequence instead of just `sk-ant-`, so operators can immediately see which one matches the key prefix they have. ## Files updated - README.md (repo root) — Two-paths table + Deploy block - openclaw/README.md (@xpr-agents/openclaw npm landing) - create-xpr-agent/README.md (create-xpr-agent npm landing) - create-xpr-agent/template/README.md (scaffolded README in every new agent directory) - create-xpr-agent/template/QUICKSTART.md (scaffolded walkthrough) - openclaw/starter/README.md (synced) - openclaw/starter/QUICKSTART.md (synced) ## Env-var tables The template README's env-var table now lists ANTHROPIC_API_KEY, OPENAI_API_KEY, XAI_API_KEY, GEMINI_API_KEY as "one-of" requirements (set exactly one), plus AGENT_LLM_PROVIDER for explicit override. AGENT_MODEL now reads "per-provider default" with the four defaults named inline. ## start.sh flags table The QUICKSTART start.sh table now shows --provider as a separate flag, --api-key as multi-provider, and the per-provider model defaults under --model. ## Versions - @xpr-agents/openclaw → 0.5.1 (README content only) - create-xpr-agent → 0.7.1 (template README + QUICKSTART + main package README) ## Verification - All four remaining "Anthropic" / "console.anthropic.com" references are intentional — they're rows in the multi-provider tables alongside OpenAI/xAI/Gemini - 80 openclaw tests pass - CI scaffold-sanity diffs covered (template ↔ openclaw/starter)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR #27 wired multi-LLM into the agent runner, start.sh, frontend, and video script — but missed every README and QUICKSTART. Those are the surfaces npm displays on package landing pages and the operator reads first. This commit fixes that gap.
Each updated file now shows the full four-provider matrix (Anthropic / OpenAI / xAI / Gemini) with key prefix, default model, and where to get a key — plus the four
./start.shvariants instead of just thesk-ant-one.Files updated:
README.md(root)openclaw/README.md(npm landing for plugin)create-xpr-agent/README.md(npm landing for scaffold)create-xpr-agent/template/README.md+ syncedopenclaw/starter/README.mdcreate-xpr-agent/template/QUICKSTART.md+ syncedopenclaw/starter/QUICKSTART.mdEnv-var table in the template README now lists
ANTHROPIC_API_KEY/OPENAI_API_KEY/XAI_API_KEY/GEMINI_API_KEYas one-of requirements +AGENT_LLM_PROVIDERfor explicit override.start.sh flags table now shows
--providerseparately from--api-key(auto-detected from prefix when omitted).Versions:
@xpr-agents/openclaw→ 0.5.1 (README content)create-xpr-agent→ 0.7.1 (template README + QUICKSTART + main package README)No code changes — paperwork that should have shipped with PR #27.