Getting Started
Get Slopcannon running on your repositories in just a few minutes.
Prerequisites
- A GitHub account
- Admin access to the repositories you want to analyze
- Organization owner access (for org-wide installation)
Installation
Step 1: Sign In
Visit slopcannon.dev (opens in a new tab) and sign in with your GitHub account.
Step 2: Install the GitHub App
After signing in, you'll be prompted to install the Slopcannon GitHub App:
- Click Install GitHub App
- Choose your organization or personal account
- Select which repositories to enable:
- All repositories - Analyze all current and future repos
- Select repositories - Choose specific repos to analyze
Step 3: Initial Sync
Once installed, Slopcannon will:
- Sync your repository list
- Import open pull requests
- Analyze historical PRs (last 90 days)
This initial sync happens automatically and may take a few minutes depending on your repository size.
Viewing Results
Dashboard Overview
Navigate to /dashboard (opens in a new tab) to see:
- Overview - Activity charts, recent scans, quick stats
- PRs - Full list of analyzed pull requests with scores
- Repos - Repository settings and stats
- Leaderboard - Team rankings by code quality
- Team - Organization members
- Settings - Global configuration options
PR Details
Click any PR to see detailed findings:
- Overall slop score
- Findings grouped by severity (High/Medium/Low)
- Code snippets with highlighted issues
- Direct links to GitHub file locations
Next Steps
- Learn How It Works to understand the detection patterns
- Configure thresholds and per-repo settings
- Review the FAQ for common questions