> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onlook.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Onlook

> Onlook is a free Mac app for designers: your team's real app runs on a canvas, an AI agent changes the code when you ask, and your engineers get a pull request.

Onlook is a free, local-first editor for designers who work in code. Your team's real app runs on a canvas, an AI agent changes its code when you ask, and your engineers get the change as a pull request to review.

<Note>
  Onlook is in beta. Things will change quickly, and some features in the app are marked "Coming soon". To tell us what worked and what broke, open a project, click **Help** and choose **Send feedback**. See [Contact the Onlook team](/help/contact).
</Note>

## Onlook at a glance

* **Who it's for:** designers who want to work on their product's real code instead of a static mockup, whether they're on a team with engineers or working on their own.
* **What it works on:** your team's code, from a folder on your Mac.
* **The canvas is the app:** every frame is a working page you can click through, not a picture of one.
* **The AI:** Claude Code or ChatGPT, on the plan you already have. Onlook doesn't charge for AI use.
* **What you hand off:** a pull request on GitHub, reviewed the way your engineers review any change.
* **Where it runs:** Macs with Apple silicon. For [Windows](https://onlook.com/waitlist?os=windows\&utm_source=docs\&utm_campaign=docs\&utm_medium=welcome), [Linux](https://onlook.com/waitlist?os=linux\&utm_source=docs\&utm_campaign=docs\&utm_medium=welcome) or an [Intel Mac](https://onlook.com/waitlist?os=mac-intel\&utm_source=docs\&utm_campaign=docs\&utm_medium=welcome), join the waitlist.

## How it works

1. **Choose the folder that holds your app's code.** Onlook makes its own copy to work in, on its own branch.
2. **Onlook starts your app.** It installs what the app needs and runs it in a frame on the canvas, at any screen size.
3. **Ask for a change in the chat.** The agent edits the copy, and the frame shows the result.
4. **Send it to your engineers.** The pill in the top bar opens a pull request for them to review.

You can also sketch ideas that don't touch your code yet, as [artifacts](/canvas/artifacts) on the same canvas.

## Learn as you go

To see what you can ask for, click **Tips** in the lower-left corner of the editor, or press **⌘/**. Tips shows example requests you can send to the chat, and every keyboard shortcut. See [Tips](/start/tips).

<CardGroup cols={2}>
  <Card title="Install Onlook" href="/start/install">
    Download it, sign in, and let macOS install what it asks for.
  </Card>

  <Card title="Quickstart" href="/start/quickstart-codebase">
    From a folder of code to your first change.
  </Card>

  <Card title="Tour the interface" href="/start/interface">
    What each part of the window is for.
  </Card>

  <Card title="How Onlook keeps your code safe" href="/start/trust">
    What Onlook does with your codebase, and what it never does.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.