Skip to main content
Welcome to ARCLUX. This guide gets you from a fresh clone to your first dependency graph in a few minutes.

​
Before you begin

Make sure you have:
  • Node.js and pnpm installed
  • Git installed
  • A codebase you want to analyze (your own repo, or clone something like vscode or react to try it out)
This guide covers running ARCLUX locally in your terminal. The web dashboard (Step 3 below) requires the same local setup — there’s no hosted version yet.
1

Clone the repo

ARCLUX isn’t published to npm yet, so you build it locally.
2

Install dependencies

3

Run your first analysis

Point the CLI at any local path:
This parses the target codebase, builds the dependency graph, and runs all 18 structural detectors (circular dependencies, dead code, orphan files, layer violations, and more).
4

Explore the graph in your browser (optional)

Open the printed local URL to browse the interactive dependency graph, trace impact, and view file details.
Running in Termux (Android) on arm64: apps/web uses Webpack, not Turbopack — Turbopack isn’t supported on this architecture. Don’t add --turbo to the dev script.

​
What’s next

Overview

What ARCLUX actually does and its current alpha status

Architecture

How the pipeline fits together: parser to graph to detectors

Status & Progress

What’s solid, what’s a stub, and what’s actively being worked on

Codebase Map

Browse every package and app in the monorepo