Getting Started
Install the GitHub App
Connect Brandlint to your GitHub repositories.
Brandlint uses a GitHub App to access your repositories and post review comments on pull requests.
Installation steps
Go to the dashboard
Visit brandlint.com and sign in with your email.
Click Connect GitHub
You'll be redirected to GitHub to authorize the Brandlint app.
Select repositories
Choose which repositories Brandlint should review. You can select:
- All repositories in your organization
- Specific repositories only
Confirm installation
Click Install to complete the setup. You'll be redirected back to Brandlint.
Permissions
Brandlint requests the following permissions:
| Permission | Purpose |
|---|---|
| Read code | Extract user-facing strings from your PRs |
| Read pull requests | Detect when PRs are opened or updated |
| Write checks | Post review results as GitHub Checks |
Brandlint never modifies your code. It only reads PR contents and writes check results.
Multiple organizations
You can install Brandlint on multiple GitHub organizations. Each organization is billed separately based on its plan.
Next step
Once installed, choose a voice template to define your brand guidelines.