OPEN SOURCE

Dependency graph, impact analysis, and structural convention checking for your codebase. CLI + web dashboard.

Interactive 3D dependency graph — nodes sized by fan-in, colored by type

---

Documentation

Note

official documentation content, searchable and organized

---

• ABOUT.md — the ARCLUX map: what it is, the intelligence layer, the platform underneath — start here if you're new
• QUICKSTART.md — start here, fast-path workflow cheat sheet
• TOOLING.md — all repo config/tooling explained (PROGRES system, git workflow, pre-commit hook, CI, CODEOWNERS, etc.)
• CONTRIBUTING.md — conventions for contributing code
• PROGRES.md (+ progres/) — up-to-date project status: what works, what's a stub, decisions, known bugs/gotchas
• ARCHITECTURE_MAP.md — boundary map for the codebase, read before adding new capabilities
• SKILL.md — auto-discovered by AI coding agents (Claude Code, Cursor, etc); teaches them to use the arclux CLI instead of guessing at codebase structure
• CONTEXT.md — project brief at a glance: stack, architecture, current state.
• progres/roadmap.md — long-term direction, phased

Status: alpha

Under active development. Core pipeline (parse/index/graph/impact), 20 detectors, 14 framework convention rules, scripting DSL, CLI + web dashboard + always-on daemon + VS Code extension are solid and verified against real repos (vscode, react, vite, laravel, flask). The persistence/cache layers are still stubs.

For the current, detailed breakdown -- see progres/status-core.md, status-web.md, and the docs site (updated continuously, this README is not).

What it does

• Builds a dependency graph (imports, exports, folders) + call graph (which functions call which, across files) from static analysis
• Traces impact - what is affected if you change file X
• Detects circular deps, dead code, orphan files, duplicate modules, layer violations, and more (20 detectors — run them all with arclux doctor)
• Enforces framework conventions (14 rules: Next.js, NestJS, Express, Vite, Electron, React, Laravel — arclux verify gates on them)
• Runs scripted analysis — arclux script file.arclux executes the ARCLUX DSL (analyze, impact, doctor, security, graph from plain-text scripts)
• Parses 27 languages: TypeScript/TSX, JavaScript, Python, Go, Java, PHP, Ruby, Rust, C++, C#, Bash, C, Dart, Elixir, Kotlin, Lua, Objective-C, OCaml, Scala, Solidity, Swift, Vue, Zig, Elm, ReScript, plus manifest formats (package.json, go.mod, Cargo.toml, Gemfile, composer.json, csproj, gradle, pom.xml, requirements.txt)

Install

npx arclux analyze .          # or any command — zero setup
npm i -g arclux               # or install once, get the `arclux` binary

The package ships every tree-sitter grammar it needs — no native compilation, no grammar installs. Node 20+.

From source (development)

git clone https://github.com/GSF-001/ARCLUX.git
cd ARCLUX
pnpm install
pnpm build:cli             # bundles apps/cli/dist/arclux.mjs + wasms/

Run CLI commands via: arclux <command> (installed) or node apps/cli/dist/arclux.mjs <command> (bundled).

Usage

arclux analyze [path]
arclux graph [path]
arclux graph [path] -o out.json
arclux impact <file> [path]
arclux doctor [path]
arclux diff <from> <to> [path]
arclux diagnose [path]
arclux verify [path]
arclux security [path]
arclux search <query> [path]
arclux script <file.arclux>
arclux config [path]
arclux shell
arclux mcp

Web dashboard:

cd apps/web
pnpm run dev

Daemon (always-on background service)

ARCLUX can run as a long-running background process that watches your repo and re-analyzes on every file change:

arclux daemon --detach
arclux daemon --status
arclux daemon --stop

The daemon exposes a local HTTP+SSE bridge (GET /analysis, GET /events) so any editor/terminal can connect -- see packages/daemon/.

VS Code Extension

A minimal VS Code extension (apps/vscode-extension/) connects to a running daemon: Problems panel diagnostics + status bar module count. Build with pnpm install && pnpm build inside apps/vscode-extension/, then load via VS Code's Extension Development Host.

How it works

repository -> parser -> graph -> detectors -> engine -> report
                          -> rules (framework conventions)
                          -> impact (consumer/dependent tracing)

Each stage is an independent package: parser, graph, impact, detectors, rules, engine.

Structure

apps/cli        command-line interface (analyze, graph, impact, doctor, config, diff, diagnose, verify)
apps/web        Next.js dashboard
packages/       parser, graph, impact, detectors, rules, engine,
                 indexer, search, watcher, incremental, repository,
                 shared, plus runtime/platform layers (kernel, storage,
                 runtime, scheduler, networking, services, ...)
                 see packages/README.md for the full list

Contributing

We use GitHub Issues to track open work. main is protected; all changes go through a pull request.

git clone https://github.com/GSF-001/ARCLUX.git
cd ARCLUX && pnpm install

See CONTRIBUTING.md for conventions, and PROGRES.md (plus progres/) for current project status before picking up work.

License — Dual

• ARCLUX Platform (apps/web, apps/cli, packages/engine/parser/graph etc.) — Apache License 2.0 (see LICENSE-ENGINE) — graph tetap open, boleh contribute
• ARCLUX MMO (packages/gameserver, packages/relay, packages/universe, apps/game) — ARCLUX MMO License v1 (GSF-001) — source-available, boleh baca & PR, dilarang deploy/host game komersial clone tanpa izin tertulis (see LICENSE-MMO, SPDX: LicenseRef-ARCLUX-MMO)
• SECURITY.md

Citation

If you use ARCLUX in research or other work, please cite it using the metadata in CITATION.cff.