inlineGuide

Get started

Connect GitHub

inline needs a connection to GitHub before it can review anything. There are two ways to connect, and the one you pick decides who your reviews post as.

Connecting is an admin task. You need permission to manage connections in your workspace, and admin rights on GitHub for the repositories you want reviewed.

#Which connection to use

Most teams want the inline bot. Choose your own GitHub account when you would rather connect without installing an App into your organization.

The inline botYour own GitHub account
A GitHub App installed into your organizationAn OAuth connection you make from the portal
Reviews post as the bot, so everyone can see which comments came from inlineReviews can post under your connected account
GitHub delivers events on its owninline sets up the repository webhooks it needs
The merge gate arrives as a check runThe merge gate arrives as a commit status

#Connect the inline bot

/settings/botOpen in app

The inline bot

Connect inline to GitHub and choose which repositories it reviews.

1

Create the bot

Create the bot on GitHub
2

Install on repositories

Install on GitHub
3

Turn on reviews

Go to Repositories
The three steps, in the order the setup flow presents them.
  1. Create the bot on GitHub.

    On GitHub bot, choose Create the bot on GitHub and name the GitHub organization it belongs to. GitHub asks you to confirm, then hands the credentials back.
  2. Install the bot on your repositories.

    Choose Install on GitHub and pick the repositories inline may see. You can change that selection on GitHub whenever you like.
  3. Turn on reviews.

    Installing the bot makes your repositories visible in the portal. Reviews start once you enable a repository, in Enable a repository.

#Connect your own GitHub account

  1. On Repositories, open the GitHub connections card.

  2. Choose Connect GitHub and finish the GitHub prompt.

    inline imports the repositories your account can administer and tells you how many it found.
  3. Turn on reviews for a repository.

    On this connection, enabling a repository is also when inline sets up the webhooks it needs on that repository.

Repositories

Install the inline bot (or connect your own GitHub), then choose which repositories receive autonomous reviews.

inline is installed

Add or remove repositories on GitHub, then turn reviews on for the ones you want below.

Add repositoriesBot settings
Repositories2 / 4 enabledSync from GitHub
pendral/inlineTypeScript · 128 reviews · threshold medium
pendral/inline-webTypeScript · 41 reviews · threshold high
pendral/design-tokensCSS · 0 reviews · threshold medium
Both connection types appear in the same card, with the repositories each brought in.

#What inline can see

inline's GitHub access comes from the connection you grant, and it asks only for the permissions its features use. You can review that access on GitHub and revoke it whenever you want.

Linking your personal GitHub account from the dashboard is a separate, identity-only link. It tells inline which pull requests are yours, so your own reviews show up on your dashboard. It grants inline no access to code.

Your database and artifact storage live in your own cloud tenancy, so your reviews, findings and evidence stay there.