Getting Started with CodeLayers
Welcome to CodeLayers! This guide will help you get up and running.
What is CodeLayers?
CodeLayers is a spatial code visualization platform for iPhone, iPad, and Apple Vision Pro. It transforms codebases into interactive 3D visualizations where you can:
- See architecture - Files organized by dependency depth, with entry points at the top and core libraries below
- Navigate spatially - Tap to select files, see connections, zoom into details
- Understand impact - See the blast radius of code changes with color-coded visualization
- Chat with AI - Ask Claude, Gemini, or Codex about your code while seeing it spatially
- Stay private - Your code is encrypted on your machine with a 12-word phrase. Our servers never see your plaintext code.
Try It Free (30 Seconds)
No account required. Explore any public GitHub PR in 3D — right from your terminal:
codelayers explore https://github.com/facebook/react/pull/31763
That's it. No clone, no checkout, no account. It opens in your browser and you can see the full architecture and blast radius instantly.
You get 10 free explores every 30 days — enough to try it on the PRs you actually care about.
You can also explore from the CodeLayers app on iPhone, iPad, or Vision Pro — open the Explore tab and paste any GitHub PR URL.
Pro Features (Your Private Repos)
For private repositories and live sync, you'll need to set up the CLI and create an account.
System Requirements
CLI (Command Line Tool)
- macOS 13+ (Ventura) on Apple Silicon
- Git installed
- Homebrew (for installation)
App
- iPhone, iPad, or Apple Vision Pro
- Apple ID for sign-in
Pro Setup
Step 1: Install the CLI
curl -fsSL https://codelayers.ai/install.sh | bash
Or with Homebrew:
brew install codelayers-ai/tap/codelayers
Verify installation:
codelayers --version
Step 2: Get Your Mnemonic
CodeLayers uses a 12-word mnemonic phrase as your encryption key. This is the only way to decrypt your code. Your encryption key syncs automatically via iCloud Keychain, so all your Apple devices stay connected.
On your iPhone, iPad, or Vision Pro:
- Download CodeLayers from the App Store
- Sign in with Apple ID
- The app generates your 12-word recovery phrase
- Write it down securely — this is the only way to recover your data!
Your encryption key is automatically stored in iCloud Keychain and shared across all your signed-in devices.
On your Mac:
codelayers login
Enter the same 12 words when prompted:
Enter your 12-word recovery phrase:
> apple banana cherry date elder fig grape honey iris jade kiwi lemon
✓ Mnemonic verified
✓ Encryption key derived
✓ Sync ID: a1b2c3...
Step 3: Sync Your Repository
Navigate to your project and start watching for changes:
cd ~/my-project
codelayers watch .
You'll see:
✓ Logged in as user_abc123
✓ Parsing 847 files...
✓ Building dependency graph... (1,523 nodes, 4,291 edges)
✓ Encrypting and syncing to backend...
✓ Backend WebSocket connected
✓ Ready for device connections
Watching for changes... (Ctrl+C to stop)
Step 4: Connect and Explore
Once the CLI is watching and your device has the same mnemonic (synced automatically via iCloud Keychain):
- Select your project from the CodeLayers app
- Wait for sync — your encrypted graph will download from the backend and decrypt
- Explore! Tap files to select, pinch to zoom, move around your space
Both the CLI and your devices connect to the backend via WebSocket, so they work from anywhere—no same-network requirement.
What's Next?
- CLI Commands Reference - All commands and options
- Web Sharing - Share 3D visualizations with anyone
- GitHub Action - Auto-generate visualizations for PRs
- App Guide - Navigation, modes, and features
- AI Agents - Tips for using Claude, Gemini, or Codex
- Privacy - How encryption works
- Blast Radius - Understand change impact visualization
Troubleshooting
"Connection failed" on your device
- Make sure CLI is running with
codelayers watch - Check your internet connection on both devices
- Verify you're logged in with the same mnemonic
"Mnemonic doesn't match"
- Double-check each word carefully
- Words are case-insensitive but order matters
- Make sure you're using the same 12-word phrase on both devices
Slow initial sync
- First sync parses every file and can take 1-2 minutes for large repos
- Subsequent syncs are incremental and much faster (under 1 second)
Need help? Check the full troubleshooting guide or email [email protected].