FAQ
Common questions about OpenCI and the CLI.
What repos can I install from?
Any GitHub repository that has workflow files in .github/workflows/. Public repos work out of the box. Private repos are supported through your normal git credentials (SSH keys, configured tokens, or any auth flow your local git already uses). OpenCI does not prompt for credentials itself.
How does update detect local changes?
When you install a workflow, OpenCI records a content hash in the sidecar metadata at .github/workflows/.openci/<workflow>.json. On update, it compares the current file hash to the recorded one. If they differ, the CLI warns you that local changes exist and asks for confirmation before overwriting. Use --force to skip the prompt.
What does doctor check?
The doctor command runs several diagnostics:
- Missing sidecar metadata for workflow files that appear to be OpenCI-managed
- Orphaned sidecar files with no corresponding workflow
- Source repo accessibility (can the recorded source still be reached?)
- Configuration issues in the
.openci/directory
How do I find workflows?
The OpenCI catalog on the homepage lists verified workflows from popular open-source repos. You can filter by category (code review, issue automation, security) or by AI provider (Claude, Codex, Gemini). Each entry links directly to the source file on GitHub.
You can also install from any repo you know about — the catalog is just a curated starting point.
Where does OpenCI store metadata?
Per-workflow sidecar metadata is stored in .github/workflows/.openci/<workflow>.json. This records the source, workflow name, content hash, and install time so list, status, and update work reliably.
Can I use private repos as sources?
Yes. Private repos are supported through normal git credentials — SSH keys, configured git credentials, or any auth flow your local git already uses. OpenCI does not prompt for credentials itself.