docs: add VLM_API_KEY + AUDIO_CAPTION_API_KEY to .env.example#99
Open
BrettKinny wants to merge 1 commit into
Open
docs: add VLM_API_KEY + AUDIO_CAPTION_API_KEY to .env.example#99BrettKinny wants to merge 1 commit into
BrettKinny wants to merge 1 commit into
Conversation
#15 wired these into dotty-behaviour/docker-compose.yml as ${VAR:-} interpolation, but .env.example only documented OPENROUTER_API_KEY and VISION_API_KEY. A user reading .env.example to learn what's available misses the two finer-grained overrides. Documents the fallback chain (OPENROUTER_API_KEY → VISION_API_KEY → VLM_API_KEY / AUDIO_CAPTION_API_KEY) so the common case (one key) is obviously sufficient. Refs #15. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the repo’s .env.example to document two additional API key environment variables used for modality-specific overrides (vision VLM and audio captioning), clarifying that a single OPENROUTER_API_KEY is typically sufficient due to the existing fallback chain.
Changes:
- Add a short preamble explaining the API key fallback behavior and when overrides are useful.
- Add commented templates for
VLM_API_KEYandAUDIO_CAPTION_API_KEY.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
#15 added
${VAR:-}interpolation for four API-key vars intodotty-behaviour/docker-compose.yml, but.env.exampleonly documented two of them (OPENROUTER_API_KEY,VISION_API_KEY). A user reading.env.exampleto learn what's available misses the two finer-grained overrides.Changes
VLM_API_KEYandAUDIO_CAPTION_API_KEYto.env.example.OPENROUTER_API_KEY) is obviously sufficient and the overrides are only for users who route vision or audio captioning to a different provider.Pure additive change — no existing var was modified or removed. The broader
.env.examplecleanup (post-#36 stale ZEROCLAW_*, deadSPEAKER_*/GREETER_*sections) is a follow-up best done after #95 merges, since which env vars are still consumed by surviving code depends on which dead consumers #95 removes.Refs #15.
🤖 Generated with Claude Code