Skip to content

[WIP] Add API Proxy section to CLI reference documentation#1567

Closed
Copilot wants to merge 1 commit intomainfrom
copilot/add-api-proxy-section-to-cli-reference
Closed

[WIP] Add API Proxy section to CLI reference documentation#1567
Copilot wants to merge 1 commit intomainfrom
copilot/add-api-proxy-section-to-cli-reference

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 1, 2026

Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.


This section details on the original issue you should resolve

<issue_title>docs: add API Proxy section to CLI reference</issue_title>
<issue_description>## Summary

The CLI reference is missing the entire API Proxy section — 10 flags representing a major feature with zero documentation.

Missing flags

Flag Description
--enable-api-proxy Enable API proxy sidecar for secure credential injection
--copilot-api-target <host> Target hostname for Copilot API (default: api.githubcopilot.com)
--openai-api-target <host> Target hostname for OpenAI API (default: api.openai.com)
--openai-api-base-path <path> Base path prefix for OpenAI API requests (e.g. /serving-endpoints for Databricks)
--anthropic-api-target <host> Target hostname for Anthropic API (default: api.anthropic.com)
--anthropic-api-base-path <path> Base path prefix for Anthropic API requests
--rate-limit-rpm <n> Max requests/minute per provider (default: 600)
--rate-limit-rph <n> Max requests/hour per provider (default: 10000)
--rate-limit-bytes-pm <n> Max request bytes/minute per provider (default: ~50MB)
--no-rate-limit Disable rate limiting in API proxy

Additional context

The API proxy sidecar (containers/api-proxy/, IP 172.30.0.30) injects real API credentials that the agent never sees. Ports: 10000 (OpenAI), 10001 (Anthropic), 10002 (Copilot), 10004 (OpenCode). This is a security-critical feature that users need documentation for.</issue_description>

Comments on the Issue (you are @copilot in this section)

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.

docs: add API Proxy section to CLI reference

2 participants