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...

Goal	Read
Install on macOS, Linux, or Windows	Getting started: install
Install a specific version, or change the install directory	Getting started: install flags
Understand Direct vs the proxy, and which one agent profile add picks	Getting started: the first agent profile add
Update, or check what agent update verifies	Getting started: updating
Verify a downloaded binary against the release attestation	Getting started: verifying a download
Remove copilot-env from a machine	Getting started: uninstall
Look up a command and its flags	Usage: commands
Check a real launch end-to-end with agent health --live	Usage: health checks
Get the cl / co / cx launchers, or their permissive variants	Usage: launchers
Let the proxy start on demand and stop when idle	Usage: managed proxy lifecycle
Give Claude Code web search on Direct, or register the MCP server elsewhere	Usage: web search for Claude Code
See what I spent, and what the usage index stores	Usage: cost reporting
Look up any agent config key and its default	Configuration
Change a proxy-side setting and know when it applies	Configuration: proxy features
Give Codex Copilot's real context windows	Configuration: Codex model catalog
Keep one CODEX_HOME per host	Configuration: per-host CODEX_HOME
Wire Claude Desktop, or see which files it touches	Configuration: Claude Desktop
Pin the proxy version or the cooldown with an env var	Configuration: environment overrides
Store the GitHub Copilot credential, or switch how it is obtained	Authentication: providers
Use a personal access token with the proxy	Authentication: PAT passthrough
See which Copilot client identity each host accepts, or pin one	Authentication: client identity
Bake the credential into one agent's config, or both	Authentication: static key
Run several sessions under different credentials or modes	Authentication: profiles
Run the CLI from a checkout	Development
See how the code is layered, and which module imports which	Architecture
See how a dry run keeps its reads and writes on one seam	Dry-run filesystem

The pages

In reading order:

1. Getting started - install and its flags, the first agent profile add and the two modes, updating, verifying a download, uninstall.
2. Usage - every command, shell integration and the launchers, the managed proxy lifecycle, health checks, web search for Claude Code, cost reporting.
3. Configuration - every agent config key with its default, the proxy-side keys, the Codex model catalog, per-host CODEX_HOME, Claude Desktop, environment overrides.
4. Authentication - the credential providers, PAT passthrough, client identity, static key, profiles.
5. Development - running from a checkout, the tasks, the env init, where the rules live.
6. Architecture - the decisions as diagrams over real files, and the layer map the lint keeps equal to the import graph.