Skip to content

Latest commit

 

History

History

README.md

English | 简体中文

Documentation

The documentation is split by task so that product policy, operations, deployment, protocol contracts, and capability validation can evolve independently.

Getting started

Getting started covers installation, client setup, the first verified response, and common setup failures.

Product support

Product support defines the supported single-user topology, the conditional private-gateway topology, unsupported deployments, and product non-goals.

Operations

Operations covers runtime presets, the models and doctor commands, diagnostics, native services, and legacy-daemon migration.

Deployment

Deployment covers local containers and placement behind an authenticated private gateway.

Protocol compatibility

Protocol compatibility describes the API surface, direct and translated routes, Responses WebSocket behavior, and known protocol boundaries.

API and configuration reference

API and configuration reference lists routes, security-related environment settings, and the authoritative CLI help entry points.

Security

Security policy explains the local trust boundary, sensitive output, hosted-dashboard privacy, and private vulnerability reporting.

Capability validation

Copilot capability validation is the English technical source of truth for what to validate, how to run the checks, the semantic validators, and the interpretation rules.

Start at the project README for the short product overview and quick start.