Skip to content

Make quick start procedure to work by fixing the minimal .env in readme#68

Merged
PsiACE merged 1 commit intoPsiACE:mainfrom
niyue:bugfix/quick-start
Feb 25, 2026
Merged

Make quick start procedure to work by fixing the minimal .env in readme#68
PsiACE merged 1 commit intoPsiACE:mainfrom
niyue:bugfix/quick-start

Conversation

@niyue
Copy link
Contributor

@niyue niyue commented Feb 25, 2026

Problem

The getting started guide in README.md showed:

  • OPENROUTER_API_KEY=your_key_here

But Bub resolves API keys with this priority:

  • BUB_API_KEY > LLM_API_KEY > OPENROUTER_API_KEY

The current env.example already includes LLM_API_KEY as a placeholder by default. As a result, the default quick start flow (cp env.example .env + filling only OPENROUTER_API_KEY) can fail, because Bub can pick that value instead of OPENROUTER_API_KEY, causing authentication failures and a confusing first-run experience.

Fix

Updated the minimal .env example in README.md to use:

  • LLM_API_KEY=your_key_here

instead of OPENROUTER_API_KEY=your_key_here.

This aligns the quick-start example with Bub’s actual key resolution order and avoids accidental key shadowing during onboarding.

Copy link
Owner

@PsiACE PsiACE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@PsiACE PsiACE merged commit d8b1858 into PsiACE:main Feb 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants