Skip to main content

Quick Start: Ship Guard in 5 Minutes

Get Ship Guard running on your repository in under 5 minutes.

Prerequisites​

  • GitHub account with admin access to a repository
  • 5 minutes of time

Step 1: Install GitHub App (1 minute)​

  1. Visit Website or Ship Guard on GitHub Marketplace
  2. Click "Set up a plan"
  3. Choose Hobby ($15/month, 14-day free trial) or a one month discount of $5 off for Hobby or Pro Plan
  4. Select your repository
  5. Click "Install & Authorize"

✅ Done! Ship Guard is now installed.

Step 2: Create Config File (2 minutes)​

In your repository, create .github/ship-guard.yml:

version: 1
default_severity: warning

rules:
  - name: "Block TODO comments"
    condition: banned-terms
    severity: error
    parameters:
      terms: ['TODO', 'FIXME']
      
  - name: "Check security issues"
    condition: ai-review
    severity: error
    prompt: |
      Check for security vulnerabilities:
      - Hardcoded secrets
      - SQL injection risks
      - Missing input validation
  • Commit and push to main branch.

Step 3: Test It (2 minutes)​

Create a test PR with intentional violations:

// test.js
const API_KEY = "sk_live_abc123"; // Hardcoded secret!

function search(query) {
  // TODO: Add validation
  return db.query(`SELECT * FROM users WHERE name = '${query}'`);
}

Open a PR → Ship Guard reviews in 5-10 seconds!

What's Next?​

⚙️ Customize Your Setup​

🆘 Need Help?​