DOCS

Getting Started

Connect Code Corgi to your repository and run your first scan in under two minutes.

Code Corgi integrates with your version control platform via webhooks. Setup takes about two minutes and requires no agent installation or code changes.

Prerequisites

  • A GitHub or GitLab account
  • Admin access to the repository you want to scan
  • A Code Corgi account — sign up on the homepage

Step 1: Create Your Account

Fill out the contact form on the homepage and select Starter (Free) or Pro. You’ll receive a welcome email with your API key and webhook secret within a few hours.

Step 2: Configure the Webhook

GitHub

  1. Go to your repository → Settings → Webhooks → Add webhook
  2. Set the Payload URL: 
    https://api.phantomcorgi.com/webhooks/github
  3. Set Content type to application/json
  4. Paste your Secret from the welcome email
  5. Under Which events, select Pull requests only
  6. Click Add webhook

GitLab

  1. Go to your project → Settings → Webhooks
  2. Set the URL: 
    https://api.phantomcorgi.com/webhooks/gitlab
  3. Paste your secret token
  4. Enable Merge request events
  5. Click Add webhook

Step 3: Open a Pull Request

Create or update any pull request in your connected repository. Within 30 seconds, Code Corgi posts a status check to your PR. If threats are found, the check details contain a full forensic report.

Step 4: Review Your First Report

A scan report includes:

  • Threat summary — count and severity breakdown
  • File-level findings — which files triggered each detection layer
  • Codepoint evidence — exact Unicode codepoint, line number, and surrounding context
  • Risk classification — CRITICAL, HIGH, MEDIUM, or INFO

What’s Scanned

Code Corgi analyzes every added or modified line in the diff. Deleted lines and binary files are skipped. Supported languages for AST analysis include JavaScript, TypeScript, Python, Go, Rust, Ruby, and Java.

Next Steps

  • Read How It Works for a technical deep-dive into the detection pipeline
  • Configure severity thresholds in your dashboard settings
  • Set up Slack alerts for CRITICAL findings under Integrations
Next → How It Works