Skip to main content

​
ARCLUX Quickstart

Read this first. Full details live in TOOLING.md, scripts/README.md, and CONTRIBUTING.md — this is just the fast path.

​
Standard workflow

git checkout ARCLUX.main git pull origin ARCLUX.main git checkout -b type/short-description git add file git commit -m “message” git push origin type/short-description gh pr create —repo GSF-001/ARCLUX —title “title” —body “description” git diff ARCLUX.main..type/short-description —stat gh pr merge NUMBER —repo GSF-001/ARCLUX —merge —delete-branch git checkout ARCLUX.main git pull origin ARCLUX.main Branch types: feat, fix, docs, chore, test, split, update main is protected — direct push will be rejected, always go through a PR.

​
Logging progress

Never edit progres/PROGRES-*.md by hand. Use the script: scripts/log-progress.sh category “short title” “what happened” Categories: status-core, status-detectors, status-web, status-infra, status-backlog, bugs, decisions, gotchas, collaborators A pre-commit hook rejects any new entry missing a date in its header — the script always formats this correctly, manual edits often don’t.

​
Before touching a file that looks empty

npx tsx scripts/checkCollaboratorMarkers.ts Confirms whether the file is already claimed by a collaborator before you start writing in it.

​
Three things people forget most

  1. Log progress before moving to the next task, not at the end of the session.
  2. Typecheck apps/web from inside apps/web, not repo root: cd apps/web && npx tsc —noEmit Running from root produces 100+ false ”@/” alias errors — known, harmless, documented in gotchas.md.
  3. /tmp does not exist on Termux. Put throwaway scripts inside the repo folder and delete them after use.

​
Where things live

TOOLING.md — full config/tooling reference scripts/README.md — what every script does CONTRIBUTING.md — project structure, how to add a detector or parser progres/collaborators.md — who owns what right now

​
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 Run arclux --help for the full, always-current command list. Web dashboard: cd apps/web pnpm run dev

​
MCP for AI (self-triggering)

ARCLUX exposes 30+ tools via Model Context Protocol. The server ships workflow instructions so AI agents use the right tool without being asked — analyze first, file_info/impact instead of manual reads, detect/doctor to verify.
See the pinned Discussion “Getting Started — install, CLI usage, MCP client config” and SKILL.md for details. New detectors/rules/parsers automatically appear as tools — no manual MCP updates.