This documentation is for people trying Parallax for the first time and running it locally from the CLI.
- Getting Started: install Parallax, start it, register your repo, and open the dashboard.
- Configuration Reference: what goes in
parallax.ymland how to register it. - CLI Reference: the day-to-day commands you will actually run.
- Troubleshooting: fixes for common setup and runtime problems.
- Parallax pulls tasks from Linear or GitHub.
- Each task runs in its own local isolated worktree.
- Parallax generates a plan first, then waits for approval before making changes.
- The dashboard is where you review plans, watch logs, retry work, and inspect PR results.
- Local state lives under
~/.parallax.
- Install:
npm i -g parallax-cli - Validate dependencies:
parallax preflight - Create
parallax.yml - Start Parallax:
parallax start - Check runtime status:
parallax status - Register config:
parallax register ./parallax.yml - Open dashboard:
http://localhost:8080