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 Windows executable.
- Download the latest
.exeinstaller from GitHub Releases. - Double-click the installer to auto-configure your system PATH.
- Run the
atlascommand globally from any terminal.
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.
- Auto Mode: If a
package.jsonis detected, Atlas handlesnpm installnatively, runs the build scripts, and securely proxies local traffic into an isolated Electron window. - Manual Mode: If no package manager is found, Atlas will prompt for a local port to proxy, enabling support for static HTML, Python, or Go servers.
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.
- Tree Explorer: Familiar VS Code-style hierarchical navigation for projects and files.
- Mermaid Rendering: Live SVG diagram rendering for Markdown architecture docs.
- Integrated Viewer: High-fidelity Markdown (GFM) and video playback for session recordings.
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.
- Console: View intercepted logs enriched with native stack traces.
- Networks: High-performance request inspector (similar to Chrome DevTools).
- Application: Fast access to page metadata, WebStorage, and cookies.
- Stability: Live control over Chaos Engineering parameters (latency, packet drops).
- Security: PII Leak prevention logging (detecting leaked AWS Keys or Secrets).
- Recorder: FFMPEG desktop capturing for retrospective debugging.
Architecture
Atlas is built with a decoupled, event-driven architecture heavily relying on Chrome DevTools Protocol (CDP).