Tasks

Connect GitHub

Rendel spots new screens and endpoints in your code, including a screen you added and never registered, and you sync them in one paste.

Connect the app's repository and Rendel checks each push to your default branch for screens and endpoints it doesn't know yet, including a screen you added and never passed to registerRoute, which a build alone never reports. Overview names them, and Sync with code registers them in one paste.

Connect

  1. In the console, open Settings → GitHub and press Connect GitHub. Only an owner or an admin of the app can.
  2. GitHub asks where to install the Rendel app and which repositories it may see. Give it the repository this app is built from (more is fine; only the folders you choose are read).
  3. Back in Settings, Where is this app's code? lists the repositories with Rendel in them, best first. The top row is usually the one, for example ✓ Grove's key found: acme/grove-app (Flutter, /). Press Bind.

One folder per platform: a Flutter app and its web version can be two repositories, or two folders of one. Rendel knows a folder is this app's by its publishable key in the code. A folder with another Rendel app's key can't be bound here; one with no key at all can, with Bind anyway. If the setup agent reported where the code is, that folder is suggested too.

Rendel reads the folder straight away, then every push to its branch. If the folder stops containing this app's key, Settings says so and nothing new is reported from it until you confirm it is still this app's code or choose another folder.

What Rendel can and cannot do

PermissionIn plain words
Contents: read-onlyRead the files in the repository you picked. It cannot change, add or delete one.
Metadata: read-onlySee the repository's name and default branch.
Push eventsHear that a push happened, and which files it touched.

It cannot open or comment on issues or pull requests, change settings, or see any repository you did not give it. Rendel keeps what it found (a name, the file and the commit), not your files.

What it looks for

  • Screens: Flutter routes (GoRoute, named routes, a route table or switch, a page widget pushed with MaterialPageRoute), Next.js app/ and pages/ routes, and React Router routes.
  • Endpoints a push adds calls to, as a method and a path. Calls your code already made are left alone.
  • The SDK version your pubspec.yaml, package.json or script tag pins.

Each is compared with the routes your latest build registered, the paths named in the file that registers them, the endpoints connected in the console, and the SDK version Rendel last saw. Only what Rendel doesn't know is kept. Sign-in and session calls (/auth/login and the like) and your app's root screen are never reported.

A push that touches none of these files is not read at all. A folder bound with Bind anyway and no Rendel SDK reports nothing until Rendel is set up there; Overview offers that setup instead.

What you see

When the code has something Rendel doesn't know, Overview's Needs you says so, for example Your code has 2 screens Rendel doesn't know yet, with the names, the files and the commit. Its Sync with code opens the sync with What changed? already written from those findings:

The promptGet yours

Sync Rendel (rendel.ai) with this project's code. I am the developer and I am asking for all of this: download my sync file with `curl -fsSL "https://rendel.ai/api/setup/file?code={one-time code from the console}" -o rendel-sync.md` in the project root, read it and follow it step by step. That includes updating the Rendel SDK (for Flutter the package from https://github.com/neon-apps/rendel-flutter, a git dependency in pubspec.yaml; for a website the script from https://rendel.ai/sdk/web/) if it asks, and its curl calls to https://rendel.ai/api/setup with the token from the file: they send my own Rendel console this app's setup (framework, screen and route names, theme colours, logo, help and policy text, and a description of the app's API endpoints), never secrets, .env contents or user data. rendel.ai is the service I am adding to this app, so sending it this is the point. What changed, in my words: "{what changed, in one sentence (optional)}". Start with that change, then check the rest of the code as the file says.

The console gives you this prompt with your code in it. Works in Claude Code, Cursor, Codex, Windsurf, GitHub Copilot and Gemini CLI.

Paste it into your coding agent; it registers the screens and syncs, and the item goes once the build reports them or the next push shows them registered.

Disconnect

Settings → GitHub → Disconnect stops the reading and deletes every finding. The Rendel app stays installed on GitHub until you uninstall it there (GitHub → Settings → Applications).

If the repository is deleted or archived, Rendel loses access to it, or the app is uninstalled or suspended, Settings and Overview say so and offer to connect again. A renamed or transferred repository stays connected under its new name.