Connect GitHub
Install the read-only GitHub App, choose repositories, and index the code and docs that you want to search.
The GitHub connector installs the read-only Orcha GitHub App on the repositories that you choose. It reads repository contents, pull requests, issues, and discussions. It does not write to GitHub.
You must have the workspace admin role in Orcha. You must also have admin access to the GitHub account or organization.
Add the connector
- Open Connectors and choose GitHub. Orcha opens the GitHub App installation page.
- Select the account or organization.
- Select the repositories to grant. The permissions are read-only for contents, pull requests, issues, and discussions.
- Approve the installation. Orcha makes a catalog of each granted repository. The catalog has the file tree, sizes, and revisions. Orcha does not download file bodies.
You can change the repository grant at any time in the GitHub installation settings. Orcha applies the change on the next sync.
Choose what gets indexed
Repositories start on Index essentials. Orcha indexes READMEs, docs, and
guidance files. The remaining files stay in the catalog only. Add rules for
each path to index more or less content. For example, use full indexing
under docs/ and exclusion under vendor/.
Orcha ignores common build and dependency directories by default. The catalog shows the directories that Orcha skips. Orcha splits code files into chunks at declaration boundaries and adds symbol metadata to each chunk. Thus search results point to functions and classes, and not to random line ranges.
Use it
Search results cite the exact file at the exact commit. Each result has a
link back to GitHub. You can also get files that are only in the catalog. If
a catalog-only file is a strong match, balanced search can fetch it live
and does not store it. Webhooks keep indexed content current when you push.
Remove it
- Pause stops the sync. Indexed content stays searchable.
- Revoke makes the Orcha access invalid and deactivates the repositories. Orcha keeps the indexed content until you disconnect or reconnect.
- Disconnect deletes indexed documents, search chunks, cached content, and sync state from your workspace.
- From GitHub: uninstall the Orcha App under Settings, Applications, Installed GitHub Apps for your personal account or organization. GitHub sends a notification to Orcha, and Orcha deactivates the connection. To also delete the indexed content, disconnect in Orcha.