Quickstart
This guide walks you through setting up Diffvideo and generating your first video. The entire process takes about 5 minutes.
Prerequisites
- A GitHub account with at least one repository
- Admin access to the GitHub organization or personal account where the repository lives
Step 1: Create your Diffvideo account
Sign up at diffvideo.com/sign-up. We use Clerk for authentication — you can sign up with your email or GitHub account directly.
Step 2: Install the GitHub App
After signing in, you'll be prompted to install the Diffvideo GitHub App on your organization or personal account. The app requests read-only access to:
- Repository contents — to read code diffs for video generation
- Pull requests — to monitor merge events and read PR descriptions
- Metadata — repository names, branches, and configuration
You can choose to install the app on all repositories or select specific ones. You can change this later in your GitHub settings.
Step 3: Connect a repository
Once the GitHub App is installed, navigate to Settings → Integrations in your Diffvideo dashboard. Your available repositories will appear. Select the repository you want to generate videos for.
Each repository can be configured independently with its own mode (suggest or autonomous), style settings, and automation rules.
Step 4: Generate your first video
With a repository connected, Diffvideo starts monitoring for events immediately. You have two options:
- Wait for a natural event — merge a PR, push to main, or create a release. Diffvideo will automatically generate a video suggestion.
- Trigger manually — from the dashboard, you can trigger video generation for recent activity on any connected repository.
In suggest mode (the default), the generated video appears as a suggestion in your Inbox. Review the suggestion, make any edits, and approve it for rendering.
Step 5: Share your video
After rendering completes (typically 2-5 minutes), your video appears in the Videos library. From there you can:
- Copy the share link to send to anyone
- Copy the embed code to place it in your docs or product
- Download the MP4 file for use anywhere
Next steps
- Set up automation rules to auto-generate videos on specific triggers
- Configure your branding to match your visual identity
- Learn about video types to generate the right content for different audiences
- Explore the changelog use case for automated release communication