> ## Documentation Index
> Fetch the complete documentation index at: https://arclux-os.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> See through your codebase before it breaks

# ARCLUX

See through your codebase before it breaks. Every codebase accumulates debt nobody can see until it's too late -- circular dependencies, dead code, files nobody remembers touching. ARCLUX builds a live dependency graph of your repo, traces the blast radius of every change, and catches structural rot before it ships.

## Get started

Not yet published to npm -- clone and build locally.

```bash theme={null}
git clone https://github.com/GSF-001/ARCLUX.git
cd ARCLUX
pnpm install
```

Run CLI commands via:

```bash theme={null}
npx tsx apps/cli/index.ts analyze [path]
```

Or start the web dashboard:

```bash theme={null}
cd apps/web
pnpm run dev
```

<Warning>
  Jalan di Termux (Android) arm64: `apps/web` pakai Webpack, bukan Turbopack --
  Turbopack belum didukung di arsitektur ini. Jangan tambahkan `--turbo` ke script dev.
</Warning>

<Note>
  Parsing TypeScript/TSX pakai TypeScript Compiler API, parsing Python pakai
  `web-tree-sitter`. Kalau nambah bahasa baru, cek `packages/parser/` dulu sebelum bikin parser baru.
</Note>

## What it actually does

<CardGroup cols={2}>
  <Card title="Dependency graph" icon="diagram-project">
    Maps every import, export, and folder into one live dependency graph
  </Card>

  <Card title="Impact analysis" icon="radar">
    Change one file, trace everything downstream before you ship
  </Card>

  <Card title="18 structural detectors" icon="magnifying-glass">
    Circular deps, dead code, orphan files, layer violations, and more
  </Card>

  <Card title="Framework conventions" icon="ruler">
    Enforces conventions, starting with Next.js -- more frameworks planned
  </Card>
</CardGroup>

## Status: alpha

This project is under active development with a small team. Expect breaking changes and stubs that aren't wired up yet.

<CardGroup cols={2}>
  <Card title="Solid today" icon="check">
    Core pipeline, TS/Python parsing, all 18 detectors, full impact analysis -- verified against `vscode`, `react`, `vite`
  </Card>

  <Card title="Not there yet" icon="hourglass-half">
    Real search, Go/Java relationship parsing, most dashboard panels
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Usage" icon="terminal" href="/usage">
    Full CLI command reference and web dashboard setup
  </Card>

  <Card title="Architecture" icon="sitemap" href="/architecture">
    How the pipeline fits together: parser to graph to detectors
  </Card>

  <Card title="Status & Progress" icon="chart-line" href="/status">
    What's solid, what's a stub, and what's actively being worked on
  </Card>

  <Card title="Codebase Map" icon="folder-tree" href="/map/map-apps-cli">
    Browse every package and app in the monorepo
  </Card>
</CardGroup>