Docs

Workflows first. Reference second.

Start with the task you need to finish: install, activate, scan, connect agents, gate PRs, export reports, or update Radar.

Direct answer

Implementation Docs

Use the docs hub to find the canonical implementation path for install, activation, local scans, MCP setup, GitHub Actions, reports, hooks, and troubleshooting.

What is the Code Radar docs hub for?

The Code Radar docs hub routes implementation intent to canonical setup paths for install, activation, local scans, MCP, GitHub Actions, configuration, reports, hooks, updates, privacy, and troubleshooting.

Which docs should a new user open first?

Start with /docs/install/, then /docs/activate-license/, then /docs/local-scan/. Use /docs/mcp/ for agent setup and /docs/github-actions/ when SARIF and pull-request gates are ready.

What makes an implementation answer trustworthy?

Documentation should expose commands, expected output, failure modes, and the next workflow route so an engineer can verify the task instead of relying on generic product copy.

What is the commercial path from docs?

The commercial path is proof before checkout: run the command, confirm evidence, then move to pricing only when reports, hooks, MCP, or repository CI slots become repeated workflow needs.

Intentroute implementation intent across install, activation, local scans, MCP, GitHub Actions, reports, hooks, and troubleshooting
Proofcommand sequences, expected output, failure modes, and linked workflow pages
Next actionopen the exact implementation doc, verify output, then connect working setup to the workflow that needs it

Implementation to revenue

Route documentation visitors to the workflow that proves value.

Docs traffic is often close to activation. Give each visitor the shortest path from setup intent to a local scan, CI gate, MCP context, or paid plan decision.

Install and activate

Best for visitors who have not yet produced findings on their own repository.

install code security scannerlocal sast installfree local sast
Start Free Preview

Run and inspect a scan

Best when the buyer needs to validate finding quality before enforcing policy.

local security review toolsource code vulnerability scannerhtml code security report
Inspect report

Automate pull-request evidence

Best when implementation intent is ready to become a paid repository workflow.

github actions security scannerupload sarif github actionspull request security scanner
Add CI gate

Connect coding agents

Best when local findings should become structured repair context for agents.

mcp code reviewmcp server for coding agentscodex code review security
Set up MCP

Hub authority ladder

Route implementation readers to rollout proof.

Docs traffic often starts as support or setup intent. The hub should move successful implementers toward local proof, CI enforcement, MCP workflows, and plan boundaries when the repeated job becomes clear.

Install and first scan

Use this when the visitor needs the shortest path from CLI setup to a local finding set.

install local sast clitry code security scannerlocal scanner preview
Install Radar

GitHub Actions rollout

Use this when implementation intent has moved from local proof to shared pull-request enforcement.

upload sarif github actionsgithub actions security scannerfail pr on vulnerabilities
Set up CI

MCP agent rollout

Use this when developers want scanner findings available inside Codex, Cursor, Claude, or another MCP client.

mcp code review servermcp security scannercoding agent security tool
Set up MCP
Docs

Getting started

Install Radar, claim Free Preview or activate a paid license, then run the first local scan.

Docs

Install Radar

Install the native Code Radar CLI on macOS, Windows, or Linux, verify the binary, and prepare a first local security scan.

Docs

Activate a license

Free Preview claims one local machine. Paid licenses claim machine slots locally and repository slots for GitHub Actions tiers.

Docs

Run local scans

Use local SAST and code-health scans for daily work, agent repair loops, and larger PRs.

Docs

MCP Server Setup

Install Radar as a local stdio MCP code review server so coding agents can inspect findings, summaries, and fix prompts.

Docs

GitHub Actions

Run Radar as a GitHub Actions security scanner, fail risky PRs, and publish SARIF evidence.

Docs

Scanner Configuration

Tune Code Radar scan profiles, report output, cache behavior, vulnerability data, exclusions, and policy thresholds.

Docs

Security Report Formats

Export SARIF reports, JSON security scan reports, HTML code security reports, and terminal evidence for review, CI, GitHub code scanning, and automation.

Docs

Rules Reference

Inspect Code Radar rules by category, understand finding identifiers, and tune policy thresholds around review-blocking risk.

Docs

Git Hooks Setup

Install a pre-commit security scanner and Git hook security scanner that runs Radar before risky code reaches a commit.

Docs

Trend history and badges

Track local score movement across scans, inspect recent history, and publish a lightweight README badge from local Radar data.

Docs

Benchmark Methodology

Measure Code Radar scan time on real repositories with repeatable cold, warm, full, and diff-scope benchmark runs.

Docs

Update Code Radar

Keep the native Code Radar CLI current across macOS, Windows, and Linux with signed update checks and rollback commands.

Docs

AppSumo activation

Activate Code Radar with an AppSumo marketplace license key, verify the entitlement, and run a first local scan.

Docs

Privacy and telemetry

What leaves the machine during scans, license checks, website visits, and CLI usage.

Docs

Troubleshooting Guide

Diagnose Code Radar install, license activation, MCP setup, GitHub Actions, report export, and local scan issues.

Documentation FAQ

Use these answers to choose the correct implementation path and verify the result before moving to a shared or paid workflow.

What is the Code Radar docs hub for?

The Code Radar docs hub routes implementation intent to canonical setup paths for install, activation, local scans, MCP, GitHub Actions, configuration, reports, hooks, updates, privacy, and troubleshooting.

Which docs should a new user open first?

Start with /docs/install/, then /docs/activate-license/, then /docs/local-scan/. Use /docs/mcp/ for agent setup and /docs/github-actions/ when SARIF and pull-request gates are ready.

What makes an implementation answer trustworthy?

Documentation should expose commands, expected output, failure modes, and the next workflow route so an engineer can verify the task instead of relying on generic product copy.

What is the commercial path from docs?

The commercial path is proof before checkout: run the command, confirm evidence, then move to pricing only when reports, hooks, MCP, or repository CI slots become repeated workflow needs.