Skip to content
AppArch AppArch Docs

Running an ArchScan and reading the report

ArchScan scans your codebase and produces a full report with a single category-weighted quality score.

Starting a scan

Section titled “Starting a scan”

There are two ways:

  • In CI: run the runner in a push/scheduled pipeline - outside an MR context it automatically switches to full-scan (ArchScan) mode (see Adding the runner to CI).
  • From the panel: use ArchScan → (project) → Run scan to scan the latest branch.
# Image pulls are authorized with your INSTALLATION credential, not the project token
# (Settings → CI/CD → Variables):
#   DOCKER_AUTH_CONFIG = {"auths":{"hub.apparch.io":{"auth":"base64(<installation-id>:<installation-key>)"}}}
archscan:
  image: hub.apparch.io/collectors/dotnet:latest
  rules:
    - if: $CI_PIPELINE_SOURCE == "push"
  variables:
    APPARCH_Collector__Token: "$APPARCH_TOKEN"
    APPARCH_Collector__ApiUrl: "https://api.yourdomain.com"
  script:
    # Optional flags: --modules archpilot,archscan (pin what runs)
    #                 --fail-on critical (fail this step when findings at/above the level exist)
    - apparch "$CI_PROJECT_DIR"

Reading the report

Section titled “Reading the report”

The report has seven sections:

  1. Summary score - a single category-weighted score + status.
  2. Findings - with code snippet and file location.
  3. SOLID breakdown - violations by the five principles.
  4. Packages - dependencies and versions.
  5. Projects - per-project metrics.
  6. Dependency map - interactive graph.
  7. Export.

Dependency map

Section titled “Dependency map”

In the report detail, the Map tab shows cross-project dependencies in an interactive graph; you can spot cycles and layer leaks at a glance.

HTML/PDF export

Section titled “HTML/PDF export”

Use Report → Export to produce a shareable report. The report language is set per workspace. For PDF, use your browser’s “Print → Save as PDF” feature.