Copilot CLI BYOK article lacks a third-party gateway example

Open Beginner friendly
#46,018 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
cli, documentation

Research direction

Open content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md and start with "Connecting to an OpenAI-compatible endpoint," comparing the existing OpenAI and local-Ollama examples. Add a short Yolo-Auto example covering the three variables, supported tool-calling and streaming models, and the 131072-token plan limit alongside COPILOT_PROVIDER_MAX_PROMPT_TOKENS; done when the gateway setup and token interaction are clear.

Written by the indexing model from the issue text.

Description

triage
Issue body

The Copilot CLI BYOK article (content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md) documents COPILOT_PROVIDER_BASE_URL / COPILOT_PROVIDER_API_KEY / COPILOT_MODEL with OpenAI and local-Ollama examples only.

The openai provider type explicitly covers "any other OpenAI Chat Completions API-compatible endpoint", but a reader connecting a third-party gateway has no worked example showing:

  • the three variables with gateway-style values,
  • which gateway models satisfy the tool calling + streaming requirements,
  • how a provider-enforced plan context window interacts with COPILOT_PROVIDER_MAX_PROMPT_TOKENS.

Proposal: add a short third-party gateway example block to "Connecting to an OpenAI-compatible endpoint". A concrete candidate is Yolo-Auto (https://yolo-auto.com/v1), whose yolo and yolo-small models support tool calling, streaming, and image inputs, and which enforces a 131072-token context window per plan.

Dominant language
TypeScript
Stars
20.9k
Forks
68.8k
Avg merge
13h 43m
Merged PRs (30d)
110

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/docs

All issues in github/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.