​
Overview

This guide covers the minimum steps to enable Charlie in your GitHub organization. Slack and Linear are optional and can be connected anytime from the dashboard.

​
Prerequisites

  • GitHub organization admin permissions (to install the app on repos)
  • Access to a Linear workspace and/or a Slack workspace (optional)
  • Ability to add repository environment variables for private builds/tests (optional)
1

Sign up to the dashboard

2

Install the GitHub App (required)

  • Click “Install on GitHub” and install the GitHub App on the repositories where you want Charlie to help.
  • After installation, you’ll be returned to the dashboard to finish setup.
3

Choose a plan and activate Charlie

Open Manage → Subscription for your organization and pick a plan. You’ll be sent to Stripe checkout. After payment, you’ll land on “Subscription activated” and Charlie becomes active for the org.
4

Invite the @CharlieHelps GitHub user

Invite the GitHub user account @CharlieHelps to your org (recommended) or per‑repo so teammates can request reviews from and mention Charlie directly in GitHub.
  • Add to organization (recommended)
    1. Open https://github.com/orgs/YOUR_ORG/people
    2. Click “Invite member” and search for CharlieHelps
    3. Invite @CharlieHelps as a member
    4. During the invite (or after acceptance), grant repository access to the target repos with the Triage role
  • Add to a single repository
    1. Open https://github.com/YOUR_ORG/YOUR_REPO/settings/access
    2. Click “Add people” and search for CharlieHelps
    3. Set the repository role to Triage and confirm the invite
This is separate from the GitHub App installation. The App provides repo access; the @CharlieHelps user enables mentions and PR review requests.
5

(Optional) Connect Linear

You can connect Linear during onboarding or later at Manage → Integrations.
  • To connect: the dashboard redirects you to Linear OAuth, then back to the dashboard.
  • After connecting, link a repository to a Linear team (Onboarding → “Link Repository & Team”, or Manage → Integrations → Linear):
    • Pick the GitHub repository
    • Pick the Linear team
    • Click “Complete Linking”
Linking ensures Charlie uses the intended repo/team without guessing.
6

(Optional) Connect Slack

You can connect Slack during onboarding or later at Manage → Integrations.
  • To connect: the dashboard redirects you to Slack OAuth, then back to the dashboard.
  • After connecting, link a repository to a Slack workspace (Onboarding → “Connect Slack”, or Manage → Integrations → Slack):
    • Pick the GitHub repository
    • Pick the Slack workspace
    • Click “Complete Linking”
7

(Optional) Connect Sentry

Let Charlie reference your error data during runs. You can connect Sentry anytime from Manage → Integrations.
  • In Sentry, create a user token with API access.
  • In the dashboard, go to Manage → Integrations → Sentry and paste the token; choose the Sentry organization to link.
  • After connecting, you can ask Charlie to “check Sentry for this issue” in Slack/Linear or a PR thread, and Charlie will pull incidents and traces as context.
8

(Optional) Add repository environment variables

If your repo needs secrets for building, linting, or tests (used by Charlie’s devbox when running your checkCommands), add them per‑repo:
  • Manage → Organization → select a repository → Environment variables
  • Add key/value pairs. Values are encrypted and hidden in the UI after save.
9

Verify everything works

  • Open or mark a pull request “Ready for review”. By default, Charlie automatically reviews PRs when opened or marked ready.
  • You can also request a review from @CharlieHelps or mention @CharlieHelps in a PR/issue comment to ask for help.

​
Behavior reference

  • Automatic PR reviews are controlled by your repository’s .charlie/config.yml (beta.automaticallyReviewPullRequests, default: true). You can add this later if you want to customize behavior. See the Configuration & advanced setup page.
That’s it. Revisit Manage → Integrations anytime to connect/disconnect Linear, Slack, or Sentry, and Manage → Billing & Usage to view credit usage.

​
First‑run tips

  • Screenshots and images are supported. When helpful, include a short caption or annotation and link related files for context.
  • Write a one‑sentence PR description with intent and non‑goals. Example: “Extract UserCard to its own file—no behavior change.”
  • Call out pure refactors or JS→TS conversions so reviews focus on the diff that matters.
  • In Slack/Linear, if the context is long, ask Charlie to briefly summarize the thread, then state the task.