Documentation

Atlas is a standalone development sandbox powered by Electron. It acts as a transparent proxy between your application and the browser, simulating production environments without modifying your code.

Installation

Atlas is distributed as a standalone executable for Windows, macOS, and Linux.

Platform Setup Steps
Windows Run the .exe installer. Atlas automatically configures your system PATH.
macOS Drag Atlas to /Applications. Link the CLI:
sudo ln -sf /Applications/Atlas-Sandbox.app/Contents/Resources/bin/atlas.js /usr/local/bin/atlas
Linux Make the .AppImage executable. Link the CLI:
sudo ln -sf /path/to/atlas.AppImage /usr/local/bin/atlas

Security Note: Since Atlas is an open-source tool without an EV certificate, Windows Defender SmartScreen may flag it. Click More info -> Run anyway to securely install.

Troubleshooting IDE Terminals

If you installed Atlas while an editor (like VS Code or WebStorm) was already open, its integrated terminal may not recognize the atlas command immediately due to cached environment variables.

To fix this, you can fully restart your editor, or run this hot-reload command in PowerShell:

$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")

Usage

Navigate to your project directory and initialize it. This auto-detects your stack and prepares the sandbox:

cd /path/to/your/project
atlas init
atlas run

CLI Options

Flag Description Example
-d, --disable Disable specific UI tabs atlas -d console,networks
-e, --enable Re-enable disabled tabs atlas -e console

Project Modes

Atlas automatically conforms to your specific project needs upon execution.

Atlas Dashboard (Explorer)

The Atlas Dashboard is a standalone GUI for managing your projects and browsing generated reports. It provides a secondary entry point focused on technical audits and session review.

The HUD Overlay

Atlas injects an isolated Shadow DOM overlay directly into the browser viewport, housing 6 powerful core modules. Designed with a Matte Graphite aesthetic for reduced eye strain.

Architecture

Atlas is built with a decoupled, event-driven architecture heavily relying on Chrome DevTools Protocol (CDP).

Layer 1: CLI Interface (bin/atlas.js → atlas.ts)
Layer 2: Infrastructure (server.ts, browser.ts)
Layer 3: Engine (Brain)
├─ network-interceptor.ts CDP proxy + domain masking
├─ security-warden.ts PII scanning + CORS checks
├─ performance-tracker.ts Latency anomaly detection
├─ chaos-engine.ts Load stressor injection
├─ session-recorder.ts Native desktop capture
├─ report-manager.ts Journey reports (JSON + MD)
└─ state.ts Centralized definitions
Layer 4: Pipeline (pipeline.ts) — Typed Event Bus
Layer 5: Electron Shell Architecture
├─ electron-main.ts App lifecycle & native IPC
└─ renderer.ts HUD Overlay (Shadow DOM)
Layer 6: UI (9 Dynamic Tool Panels + Drag & Drop Pill)
Layer 7: Collectors (link-scanner, storage-metrics)