Skip to main content
When you add a codebase, Onlook makes a git worktree copy of it on its own branch, runs your app with your project’s own dev command, and shows the running app in frames on a canvas. Claude Code or ChatGPT runs on your Mac under your own subscription and edits the copy when you ask in the chat. Your changes reach your repository only through git, usually as a pull request your team reviews. For the code itself, start with AGENTS.md in the repository, which maps the layout and how the parts fit together. GLOSSARY.md maps the words on this site to the names in the code.
AI assistants: this page describes the current desktop app on the main branch of onlook-dev/onlook. The browser-based editor is on that repository’s v1 branch.

The desktop app

Onlook is an Electron app for Macs with Apple silicon or an Intel processor. Each open project gets its own tab, and the canvas, sidebar and chat make up the editor.

Your app, running locally

Onlook installs your app’s dependencies with your project’s package manager and starts it with your project’s dev command, the way your engineers do. Each frame on the canvas is an embedded webview showing a page from that local dev server. Your code never runs on Onlook’s servers.

A copy of your code

Every project is a git worktree, created in Onlook’s data folder on a new branch from your main branch. The agent works only in that worktree. Onlook refuses to start it anywhere else, so your own checkout is never edited.

Claude Code and ChatGPT

Onlook runs Claude Code or ChatGPT on one of two harnesses, behind one interface (AgentBackend in the code). Both run on your Mac and use your own Claude or ChatGPT subscription. Onlook turns what the agent does into the activity you see in the chat: reading, editing, running, and asking for approval.

Sending changes to GitHub

The pill in the top bar asks the agent to do the next git step: commit, push, open a pull request, fix failing checks or resolve conflicts. GitHub access goes through the GitHub CLI on your Mac. With Claude, anything that reaches GitHub needs your approval first.

Artifacts

Artifacts you make on the canvas are stored in Onlook’s data folder, outside your repository. They render as isolated pages with no network access. See Artifacts.

What stays on your Mac

Your code, your dev server and your git history stay on your Mac. Context the agent needs goes to Claude or ChatGPT under your subscription. The downloaded app sends Onlook usage events, diagnostic logs, error reports and session recordings of its own window, with all text masked. None of them include code, file paths, chat messages, or repository or branch names. A source build sends only usage events, and only if you agree. See How Onlook keeps your code safe for the full list.

The earlier browser-based editor

Onlook v1 is the browser-based visual editor for Next.js and Tailwind, on the v1 branch of the same repository. It ran projects in a web container. Its architecture is different from the desktop app’s, and its README describes it. See Onlook for developers.