Docs

Vortex documentation

Install the macOS beta, learn the understand → plan → implement → verify loop, and steer every change with plan files and Review mode.

Vortex is an agentic coding platform for macOS. You describe the work; it understands your workspace, plans the approach, edits across files, and verifies the result.

These pages cover the parts you touch day to day. Everything runs on your machine: retrieval, workspace state, and optional local models stay local, and cloud requests go straight to the provider whose key you supply.

Vortex is in a closed beta on macOS 12+ (Apple Silicon recommended, Intel supported). Join the waitlist to get an invite.

Getting started

Quickstart

Install the Vortex macOS beta, connect a model, and run your first agent job through understand, plan, implement, and verify.

Getting started

Install and updates

Install the Vortex macOS beta, sign in with GitHub, follow the Beta update channel, and find logs, config, and a clean uninstall path.

Control points

Plan files

Plan mode writes an editable Markdown plan file to .vortex/plans/ before the agent implements, so you review the approach, not the diff.

Control points

Review mode

Review mode stages every agent edit as a pending patch in the Changes panel, so nothing reaches disk until you approve it.

Configuration

MCP integrations

Connect Model Context Protocol servers to extend the agent's tool surface per workspace, with OAuth sign-in and secrets that are never shown.

Configuration

Models and keys

Bring your own OpenAI, Anthropic, OpenRouter, or OpenAI-compatible key, or run a local GGUF model, and pick where each step runs.

Automation

Headless CLI

Run the same workspace from the terminal with vortex run and vortex review, including detached jobs, CI gates, and review rules from AGENTS.md.

Automation

SSH remote workspaces

Add a remote host and work in a remote directory from the same UI, with a matching vortex-server deployed to the host over SSH.