App Builder

GitHub Integration

GitHub Integration - Opulent documentation

GitHub Integration

Your code, your repo — Opulent builds and commits; you own everything

What it is

Every application built with Opulent is backed by a GitHub repository. Opulent commits every change automatically, maintaining a complete version history. You can clone the repo, edit locally in any IDE, and push back — Opulent pulls your changes before making the next edit, keeping everything in sync.


How It Works

Automatic Repository Creation

When you start building, Opulent creates a private GitHub repository in your account:

"Build a SaaS dashboard" → Repository: github.com/you/saas-dashboard

Or specify a name:

"Build this into a repo called 'customer-portal'"

Two-Way Sync

DirectionWhen It Happens
Opulent → GitHubAfter every edit session — changes are pushed to the main branch
GitHub → OpulentBefore every new edit — Opulent pulls latest from main to avoid conflicts

Working Locally

Clone the repo and edit in VS Code, Cursor, or any editor:

git clone https://github.com/you/your-app
cd your-app
npm install && npm run dev

Push your changes:

git add .
git commit -m "Refined the dashboard layout"
git push origin main

Return to Opulent — it automatically pulls your changes and continues from there.


GitHub Connector Capabilities

Connecting GitHub also activates the GitHub Connector for the agent:

CapabilityWhat the Agent Can Do
CodeRead, write, commit, push, pull
IssuesCreate, view, update, close
Pull RequestsCreate, review, merge, close
ProjectsInteract with GitHub Projects boards
ActionsCheck workflow runs, read logs
"Create a GitHub issue for the navigation bug we just fixed as a note for the team"
"Open a PR for these changes with a description of what was updated"

Connecting an Existing Repository

Already have a codebase? Connect it:

  1. Go to the chat input → Attach → Connect Repository
  2. Search for your GitHub repo
  3. Opulent clones it and works from your existing code

From that point on, all agent edits commit to your repo.


Disconnecting

Disconnecting GitHub removes the sync but does not delete your repository. You retain full ownership and all history. Your Opulent project simply stops committing to it.


Tips

Use Opulent for structure, your IDE for precision. Let Opulent scaffold the application and build the complex parts. Then export to GitHub and use your editor for fine-grained styling and business logic. Sync back to Opulent for deployment.

Don't rename the repo after connecting. Changing the repository name or owner on GitHub after the connection is established breaks the sync. If needed, disconnect and reconnect with the new repo name.

Use branches for experiments. Opulent commits to the main branch by default. Create a branch locally for experiments, then merge when ready.


Common Questions

Can I use GitLab or Bitbucket instead of GitHub? GitHub is the primary supported integration. GitLab and Bitbucket support are on the roadmap.

What happens to uncommitted local changes when Opulent pulls? Opulent pulls from the remote main branch, not your local working copy. Commit and push your local changes before asking Opulent to make edits to the same files.

Can I have multiple GitHub repos for one Opulent project? Each Opulent project maps to one GitHub repository.

Is the repository public or private? Private by default. You can make it public from GitHub settings at any time.