Skip to content
On this page

copilot-env ​

copilot-env points the Codex and Claude CLIs at GitHub Copilot, either through a local @jeffreycao/copilot-api proxy it manages or straight to Copilot Direct. Everything it does is an agent subcommand or an agent config key, and these pages cover them by task.

I want to... ​

GoalRead
Install on macOS, Linux, or WindowsGetting started: install
Install a specific version, or change the install directoryGetting started: install flags
Understand Direct vs the proxy, and which one agent profile add picksGetting started: the first agent profile add
Update, or check what agent update verifiesGetting started: updating
Verify a downloaded binary against the release attestationGetting started: verifying a download
Remove copilot-env from a machineGetting started: uninstall
Look up a command and its flagsUsage: commands
See what the shell integration sets upUsage: shell integration
Check a real launch end-to-end with agent health --liveUsage: health checks
Get the cl / co / cx launchers, or their permissive variantsUsage: launchers
Let the proxy start on demand and stop when idleUsage: managed proxy lifecycle
Give Claude Code web search on Direct, or register the MCP server elsewhereUsage: web search for Claude Code
See what I spent, and what the usage index storesUsage: cost reporting
Look up any agent config key and its defaultConfiguration
Change a proxy-side setting and know when it appliesConfiguration: proxy features
Give Codex Copilot's real context windowsConfiguration: Codex model catalog
Keep one CODEX_HOME per hostConfiguration: per-host CODEX_HOME
Wire Claude Desktop, or see which files it touchesConfiguration: Claude Desktop
Pin the proxy version or the cooldown with an env varConfiguration: environment overrides
Store the GitHub Copilot credential, or switch how it is obtainedAuthentication: providers
Use a personal access token with the proxyAuthentication: PAT passthrough
See which Copilot client identity each host accepts, or pin oneAuthentication: client identity
Bake the credential into one agent's config, or bothAuthentication: static key
Run several sessions under different credentials or modesAuthentication: profiles
Run the CLI from a checkout, or find the tasks, the env init, and the rulesDevelopment
See the decisions as diagrams over real files, and which module imports whichArchitecture
See how a dry run keeps its reads and writes on one seamDry-run filesystem

The pages ​

In reading order: Getting started, Usage, Configuration, Authentication, Development, Architecture.

Built from main at 5633904Source: docs/README.md