Skip to content

Your first scan

This page walks through a scan end-to-end. Pick any TypeScript / Vue / React / Svelte project you have lying around — even a small one is fine.

1. Open the project

In the desktop app, hit Open Project and pick the repository root (the directory with package.json).

Archora detects the framework, reads tsconfig.json (including extends chains), and shows a confirmation panel with the auto-detected entry points. Adjust the include / exclude globs if needed, then Scan.

The scan runs entirely in-process. For ~1000 modules it takes about 2 seconds; for ~5000 modules — about 10 seconds.

2. Read the Overview

When the scan finishes, you land on the project page:

  • Overview — architecture grade, main risk and the first recommended fix.
  • Priority queue — severity, reason, target and next action.
  • Inspector — problem, evidence, suggested fix, impact and raw details when needed.

The first question is not “what does the graph look like?” It is “what should I fix first, why, and how do I verify it safely?”

3. Drill into a hot zone

Open Hotspots or select a high-risk row in Explorer. The Inspector keeps the diagnosis visible:

  • why the module or folder is risky;
  • incoming/outgoing dependency evidence;
  • suggested verification path;
  • related cycles or rule violations.

If you have an editor configured (see Configuration), the file path is clickable and opens in your editor.

4. Understand a cycle

Open Cycles. Cycles are shown as repair items, not as a raw node-link graph:

  • readable dependency chain;
  • direct/indirect severity;
  • suggested breakpoint;
  • affected modules and related violations.

The suggested breakpoint is computed from the cycle evidence and is meant to narrow the refactor, not to auto-rewrite business code.

5. Save a snapshot

Open Export in the project TopBar:

  • Full HTML report — readable architecture brief for review.
  • Fix plan JSON — evidence-backed repair queue for planning.
  • Full JSON report — complete analyzer payload for integrations.

What's next on the project page

  • Cmd+K — quick search across modules with path:, export:, import:, kind: prefixes.
  • b — saved views: bookmark useful filter and selection states.
  • TopBar Layers icon — GUI editor for .archora.json layer overrides with live violation preview.
  • Settings → Watcher — auto re-scan whenever a relevant file changes (Tauri only).
  • Wand-shaped button on a type-only-candidate insight — one-click importimport type rewrite with side-by-side diff and backup.

See Working with the Architecture Workspace for the full walkthrough.

Next