This documentation set is split by purpose so the main README can stay focused on discovery, value, and quick onboarding for OpenCode ChatGPT OAuth/Codex workflows.
- Getting Started: full install, auth, configuration templates, model selectors, and first-run verification
- Tools and CLI: complete catalog of 24
codex-*tools and standalone bin commands - Architecture Overview: public map of the installer, OpenCode plugin entry, TUI plugin, tool registry, request pipeline, rotation, and storage model
- Configuration Reference: config keys, environment variables, fallback behavior, and file locations
- Troubleshooting: common failure modes and recovery steps
- FAQ: short answers for common questions
- Privacy & Data Handling: what is stored locally, what is sent upstream, and how to delete it
- Architecture
- GitHub Discoverability
- Configuration Flow
- Configuration Fields
- Testing Guide
- TUI Parity Checklist
Files under audits/ are a historical review archive. They are useful for context but are not the source of truth for current package behavior (v6.9.1). Prefer the guides above and CHANGELOG.md for live contracts.
- The root README is the landing page and 60-second start.
- Use CHANGELOG.md for release history instead of treating the README as a release log.
- The docs in this folder are the canonical public docs surface for the repository.