---
title: "Quick Start with GitHub"
description: "Get up and running with Forkline in 5 minutes."
section: "get-started"
url: "https://forkline.dev/docs/getting-started/quick-start"
markdown: "https://forkline.dev/docs/getting-started/quick-start.md"
source: "src/content/docs/getting-started/quick-start.mdx"
---
# Quick Start with GitHub
Get up and running with Forkline in 5 minutes. This guide walks through the shortest path from sign-in to a live runner.
_Interactive figure (QuickStartFlowDiagram) — see the HTML version of this page._
## Prerequisites
Before you begin, make sure you have:
- A GitHub, GitLab, or Forgejo account
- A repository you want to work with
- An AI provider API key (Anthropic, OpenAI, and similar) if you want models beyond Forkline's included free options
## Step 1: Sign In
Sign in to Forkline to access your dashboard:
1. Navigate to the Forkline sign-in page
2. Click **Sign in with GitHub** or your preferred provider
3. Authorize Forkline to access your account
4. If your email is already registered, verify your email address
After clicking **Sign in with GitHub**, you are redirected to GitHub to authorize Forkline:
> **Note**: If you already have an account with the same email, Forkline prompts you to link your GitHub account.
After signing in, you will see the welcome modal introducing the first steps:
### GitHub App Permissions
When installing the Forkline GitHub App, you cannot modify the requested permissions. You can only accept or deny the installation.
- **Contents** (write): Clone repositories and push commits
- **Issues** (write): Read and comment on issues
- **Pull requests** (write): Create PRs, read PR details, and comment on PRs
These permissions are fixed by Forkline. Your choice is binary: accept the app as requested or deny the installation.
## Dashboard Overview
After signing in, you land on the main dashboard:
The dashboard highlights:
- Your balance and usage
- Recent runners and repositories
- Quick actions to start new work
### Navigation Tips
Use Ctrl+K (Windows/Linux) or Command+K (Mac) to open the command palette for quick navigation:
Click your avatar in the top-right corner to access settings, theme, and logout:
## Step 2: Connect a Git Provider
Forkline needs repository access before it can create runners:
1. Navigate to **Git Providers** in the navbar
2. Click **Connect Provider** or **Add Provider**
3. Select your git provider
4. Complete the provider-specific authorization flow
Provider-specific notes:
- **GitHub**: Authorize the app installation flow
- **GitLab / Forgejo**: Enter your instance URL and PAT or token
## Step 3: Configure an AI Provider
Add your AI provider API key if you want access to more models:
1. On the **Git Providers** page, scroll to **AI Providers**
2. Click **Add Provider**
3. Select your preferred provider
4. Enter your API key and click **Save**
> **Note**: Forkline includes free OpenCode Zen models. Adding your own keys unlocks GPT, GLM, Kimi, Claude, and other premium model families.
## Step 4: Activate a Repository
Repositories from your connected providers appear automatically:
1. Navigate to **Repositories**
2. Find your repository in the list
3. Click **Activate**
The repository status changes from **Available** to **Active**:
> **Note**: Repositories sync automatically from your git providers. If a repository does not appear, check whether the git provider has access to it.
## Step 5: Start a Runner
Once the repository is active, start your first runner:
1. From the **Repositories** page, click the active repository card to open its runners view
2. Click **Start runner**
3. In the **Start runner** modal:
- Optionally, enter a custom name for the runner
- Select a runner size: Basic, Advanced, or Pro
- Optionally, to use a specific model, select from the dropdown
4. Click **Start**
> **Note**: On the **Repositories** page, clicking the repository name opens the repository on your git provider. Click the card to continue inside Forkline.
The runner is usually ready in 30 to 60 seconds. Status moves from **Pending** to **Starting** to **Running**.
## Triggering Runners via Webhooks
You can also start work automatically from GitHub events:
1. Open an issue in your repository
2. Mention `@forkline` in the issue body or a comment
3. Forkline starts a runner to work on it
> **Note**: Webhook automation requires configured webhooks in your git provider.
## Step 6: Connect to Your Runner
Once the runner is running, connect to it in the interface that matches your workflow.
**Browser**
- Click the runner URL to open the web interface
- Use the built-in chat, file browser, and terminal
**Desktop App**
- Get your OpenCode password from **Settings** -> **Security**
- Open the OpenCode desktop app
- Enter your runner URL and OpenCode password
> **Tip**: The desktop app works best for longer interactive sessions with file editing, terminal access, and collaboration.
## What to Do Next
Now that you have a runner running, the next useful steps are usually:
- **Ask the AI to make changes**: Describe the work in natural language and review the result in your runner.
- [Set up repository secrets](https://forkline.dev/docs/repositories/secrets)
- [Create setup scripts](https://forkline.dev/docs/repositories/setup-scripts)
- [Configure webhooks](https://forkline.dev/docs/automation/webhooks)
- [Learn about runner sizes](https://forkline.dev/docs/runners/sizes)