Documentation

Technical Debt Radar
Documentation

Everything you need to set up architecture governance, configure detection rules, and block dangerous code from reaching production.

Quick StartFirst scan in 5 minutes→ConfigurationSet up radar.yml & rules→CLI ReferenceAll 9 commands explained→

Browse by Section

70 pages

Getting Started4Install Radar and run your first scan in under 5 minutes.Configuration5Configure radar.yml, rules.yml, architecture presets, and rule packs.Analysis7Deep dive into all 6 debt categories and 39+ detection patterns.CLI Reference8All 9 CLI commands with options, flags, and output examples.Integrations4GitHub App, GitHub Action, GitLab CI, and badge generation.Dashboard6Tour the 24-page dashboard: graphs, trends, policy editor, and more.AI Features7AI-powered fixes, summaries, PR comments, and cross-file analysis.Scoring & Gates3How the debt delta score works, gate rules, and fixing strategies.Billing4Plans, pricing, payment methods, and invoice management.Teams & Organizations3Organizations, roles, invitations, and plan enforcement.Guides6Step-by-step tutorials for common stacks and workflows.API Reference6All 65+ REST API endpoints with request/response examples.Reference7Violation catalog, ORM detection, environment variables, and changelog.

Technical Debt Radar Documentation