Get started

Quickstart

Open a repository, read a flow, and see what changed on your branch.

  1. Open a repository

    On Home, press ⌘O and pick a folder, or connect GitHub to clone one. One project is one repository.

    vivibe detects the languages and frameworks and starts analysing. A quick pass shows first; a refining chip stays up while the full analysis finishes.

  2. Pick an entry point

    The Diagram screen opens on the whole branch. Use the flow picker to choose an entry point: a route, a job, a consumer or a page.

    Each box is a function; each edge is a call the engine found in the code. Click a box to see its code.

  3. See what changed

    Press ⌘⇧B to open the branch menu and choose Compare, Worktrees, Uncommitted or Pull requests. Added boxes get a teal border, removed ones turn grey and dashed, changed ones violet.

  4. Ask about it

    Sign in (Settings → Account), then click the chat button at the bottom right. Ariadne answers about the flow on screen and cites the code.

  5. Run it

    Start Docker, then open Simulate in the right rail. vivibe starts the service with its database and sends a real request through the flow.

Next