← Back to home

Design Partner Quick Start

Welcome! You have free Pro access for 3 months. Here's how to get the most out of Technical Debt Radar in 10 minutes.

1Install and scan (2 minutes)

$ npx technical-debt-radar scan .

You'll see a full violation report — architecture drift, runtime risks, ORM anti-patterns, and reliability issues.

2Generate your config (2 minutes)

$ radar login
$ radar init

This auto-detects your framework, ORM, and architecture pattern, then generates radar.yml with the right preset. We recommend starting with warn-only mode until your team is comfortable.

3Set up PR gates (3 minutes)

Add the GitHub Action to your CI:

name: Technical Debt Radar
on:
  pull_request:
    branches: [main, develop]
jobs:
  radar-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: technical-debt-radar/action@v1
        with:
          fail-on: critical
          radar-token: ${{ secrets.RADAR_TOKEN }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Full GitHub Action setup guide →

4Try the AI fix loop (2 minutes)

$ radar scan --format ai-prompt | pbcopy

Paste into Claude Code or Cursor. The AI will fix all violations. Then run radar scan again — your score should drop.

5Add a badge to your README (1 minute)

$ radar badge --owner your-org --repo your-repo

Copy the markdown into your README.md.

Giving Feedback

We want your honest feedback — especially about:

  • False positives — violations that aren't real issues
  • Missing detections — real issues Radar missed
  • Config confusion — radar.yml or presets that don't make sense
  • CLI friction — anything that slowed you down
GitHub Issues: Open an issue

Success Criteria

After 2 weeks, we'll check in on:

  • [ ]Install completed in < 10 minutes
  • [ ]< 5 false positives per repo
  • [ ]At least 3 blocking findings your team agreed were real issues
  • [ ]AI fix loop completed at least once
  • [ ]Radar still enabled after 2 weeks