Connect GitHub and index the part of your codebase that Userorbit agents should analyze. The index gives agents product context for Help Center, release, and other content proposals.
If the repository you need is missing later, update the GitHub App installation and grant access to that repository.
Userorbit shows indexing progress until processing is complete. Include and exclude paths should be relative to the repository root, without a leading slash.
Use a smaller, product-facing scope when a monorepo contains unrelated services, generated files, or internal documentation that agents should not use as customer-facing context.
Generated proposals appear in Agents → Inbox for review.
Indexed-file limits Free and Trial workspaces can index up to 100 files. Paid workspaces can index up to 800 files. If you set a custom index budget, it must be at least 20 files and cannot exceed your workspace limit.
Connect GitHub
- Go to Settings → Integrations.
- Open GitHub and select the option to install or connect the Userorbit GitHub App.
- In GitHub, grant access to the repositories you want Userorbit to read.
- Return to Userorbit when the installation is complete.
If the repository you need is missing later, update the GitHub App installation and grant access to that repository.
Start the first index
- Go to Agents → Inbox.
- In the indexing setup, select a repository.
- Optionally enter Include paths to limit indexing to specific folders.
- Optionally enter Exclude paths for folders that agents should ignore.
- Under Max files to score, enter an index budget or leave it empty.
- Choose an App directory, or keep Auto-detect.
- Turn Generate initial suggestions on if you want agents to create proposals when the first index completes.
- Select Start Indexing.
Userorbit shows indexing progress until processing is complete. Include and exclude paths should be relative to the repository root, without a leading slash.
Change the indexed scope
After the first index completes, go to Agents → Repository.- On Workspace, turn on Restrict index to selected paths, then add include or exclude paths.
- On Data, turn on Apply max indexed file limit and set the number of files to score.
- Select Save in the page header to apply your changes.
Use a smaller, product-facing scope when a monorepo contains unrelated services, generated files, or internal documentation that agents should not use as customer-facing context.
Re-index or analyze recent changes
Open the Health Check tab to review the current status, branch, and last indexed time.- Select Re-index Repository to rebuild the index.
- Select Trigger Agents, choose the last 1, 2, 7, or 30 days, and select Start to analyze commits from that period and generate proposals.
Generated proposals appear in Agents → Inbox for review.