Repository navigation
Docs: Clarify GitHub Copilot requirement and BYOK provider status #323
Description
@bradygaster Is GitHub Copilot a hard requirement?
Before we fix the docs, we need to know: Is GitHub Copilot the only supported LLM backend, or can users bring their own API keys (OpenAI, Anthropic, Azure OpenAI, Ollama)?
The SDK has a fully typed SquadProviderConfig interface in packages/squad-sdk/src/adapter/types.ts (lines 655-683) supporting openai, azure, anthropic, and local providers ΓÇö but it's completely undocumented. Is this:
- Implemented and ready ΓÇö just missing docs?
- Partially implemented ΓÇö not ready for users yet?
- Intentionally internal ΓÇö Copilot is the only supported path?
The doc fix below depends on your answer. We'll write the correct framing once we know the intent.
The Problem (Docs Audit Findings)
A user arriving with only an OpenAI or Anthropic API subscription cannot determine from the docs whether Squad will work for them. The docs currently:
- Never explicitly state that Squad requires GitHub Copilot as the LLM backend
- List "GitHub Copilot" as a requirement without explaining why or what it provides
- Say "16 models across 3 providers (Anthropic, OpenAI, Google)" ΓÇö implying direct API access
- Have zero documentation for
SquadProviderConfig/ BYOK usage - No FAQ entry for "Can I use Squad with just an OpenAI/Anthropic API key?"
User journeys that fail
| User | What happens |
|---|---|
| Has OpenAI API key only | Sees "OpenAI" in model docs, installs Squad, hits Copilot auth errors |
| Has Anthropic API key only | Sees "Claude Opus, Sonnet, Haiku" listed, expects to configure API key, no docs exist |
| Evaluating Squad | Reads install guide, sees "GitHub Copilot" listed, unclear if mandatory or optional |
Specific files with gaps
| File | Issue |
|---|---|
README.md |
No "Platform Requirements" section explaining Copilot's role |
docs/.../installation.md |
Lists Copilot as requirement but doesn't explain it's the model access layer |
docs/.../model-selection.md |
"16 models across 3 providers" implies direct API access |
docs/.../switching-models.md |
One buried line about "subscription tier" ΓÇö never clarified |
docs/.../guide.md |
Same ambiguous requirements list |
SDK evidence of BYOK support
packages/squad-sdk/src/adapter/types.ts lines 655-683:
ypescript export interface SquadProviderConfig { type?: "openai" | "azure" | "anthropic"; baseUrl: string; apiKey?: string; bearerToken?: string; azure?: { apiVersion?: string; }; }
Comment: "Custom provider configuration (BYOK). When specified, uses the provided API endpoint instead of Copilot API."
Zero docs, zero samples, zero tests found exercising this interface.
Proposed Fix (after Brady's answer)
If Copilot is the only supported path:
- Add explicit "Platform Requirements" section to README
- Update installation.md: "Squad routes all LLM requests through GitHub Copilot"
- Add FAQ: "Can I use Squad without GitHub Copilot? No."
- Update model-selection.md intro to clarify Copilot is the broker
- Mark
SquadProviderConfigas internal or add "experimental/unsupported" note
If BYOK is supported:
- Document
SquadProviderConfigwith working examples - Add config reference page
- Add samples for OpenAI direct, Anthropic direct
- Update installation.md to show both paths
Severity: High ΓÇö blocks adoption from users with direct provider subscriptions
Audit by: PAO (DevRel)
Requested by: Dina Berry
Next step: Assign to squad for doc fix once Brady clarifies the BYOK question above.
Activity
chore(squad): Epic github#323 complete — all phases shipped 🎉
test: E2E integration tests for REPL flow (github#379)
test: human journey E2E tests - 7 real user scenarios, 39 assertions (g…
Product Love: First 10 seconds that make you want the next 10 minutes (…
fix: correct ThinkingIndicator test assertion (github#415)
Fix github#422: Add context to thinking spinner (github#435)
Fix github#422: Add context to thinking spinner (github#436)
Fix github#420/github#425: Add SDK connection feedback (github#437)
Fix github#432: Show retry warnings earlier (github#441)
fix: update test assertions to match new UX copy (github#443)
bradygaster commentedon Mar 10, 2026
Great audit, @diberry. This one's blocked on Brady's answer about BYOK/
SquadProviderConfigsupport.@bradygaster — diberry found the
SquadProviderConfiginterface (packages/squad-sdk/src/adapter/types.tslines 655-683) supportingopenai,azure,anthropicproviders. Is this:The doc fix depends on the answer. Labeling for triage.
github-actions commentedon Mar 10, 2026
📋 Assigned to PAO (DevRel)
Issue: #323 — Docs: Clarify GitHub Copilot requirement and BYOK provider status
PAO will pick this up in the next Copilot session.
bradygaster commentedon Mar 10, 2026
Triage by PAO
This issue is blocked on a strategic decision: Is GitHub Copilot the only supported LLM backend, or is BYOK (bring-your-own-key) a supported path?
What I found:
Before writing docs:
Per team directive (v0.8.25): Doc-impact review is mandatory for all PRs. This affects the installation guide, model selection guide, and README — so once the decision is made, the doc fix is high-priority.
Ready to draft on your signal. 🚀
github-actions commentedon Mar 13, 2026
squad:mcmanus. Check.squad/team.md(or.ai-team/team.md) for valid member names.github-actions commentedon Mar 13, 2026
📋 Assigned to PAO (DevRel)
Issue: #323 — Docs: Clarify GitHub Copilot requirement and BYOK provider status
PAO will pick this up in the next Copilot session.
docs: clarify GitHub Copilot requirement and BYOK status
docs(ai-team): Scribe log — PAO orchestration, Copilot-only decision …
docs: clarify GitHub Copilot requirement and BYOK status
diberry commentedon Mar 15, 2026
Closing as out of scope — Squad's goal is GitHub Copilot CLI as the sole supported backend. BYOK/multi-provider support is not on the roadmap. If scope changes in the future and BYOK becomes a goal, this issue should be reopened and the docs updated accordingly. — squad obo dina
diberry commentedon Mar 15, 2026
Note: The current product goal is Copilot CLI only (not BYOK). Closing this as out of scope for now - if scope changes to support BYOK providers, this issue should be reopened and addressed. - squad obo dina