Documentation
May 3, 2026 ยท View on GitHub
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.
Start Here
- Getting Started: full install, auth, configuration templates, model selectors, and first-run verification
- Architecture Overview: public map of the installer, OpenCode plugin entry, TUI plugin, tool registry, request pipeline, 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
Maintainer and Architecture Docs
- Architecture
- GitHub Discoverability
- Configuration Flow
- Configuration Fields
- Testing Guide
- TUI Parity Checklist
Notes
- 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.