README.md

Codex Relay documentation

Start with the product overview. Choose the guide for what you want to do; you do not need the implementation reports to install Relay.

Understand

• Architecture and source-of-truth boundaries
• Native navigation and entity homes
• Canonical protocol and synchronization
• Codex account data and notification behavior
• Current status, distribution and compatibility

Install

Start with downloads and the shortest installation path.

1. Linux Hub
2. iPhone download and pairing
3. Linux Agent or macOS Agent
4. Native notification setup

Operate

• Upgrade safely
• Troubleshoot and collect diagnostics
• Controllers, enrollment and recovery

Develop

• Contributing
• Native iOS and screenshots
• Testing and test isolation
• Localization
• Release engineering
• Provider boundary

Security

Read SECURITY.md before exposing a Hub. Relay credentials grant control of local Codex work; OpenAI credentials stay on workers.

Engineering reference

Dated evidence: v0.1.0, v0.1.0 refresh, M1, M2, live event audit. Historical records preserve earlier investigations.