> ## 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.

# Onlook for developers

> Build Onlook from source, learn how it fits together, and send us changes.

Onlook is open source under the Apache 2.0 licence. The desktop app's code is at [github.com/onlook-dev/onlook](https://github.com/onlook-dev/onlook). It holds the Electron app, the canvas, and the layer that runs Claude Code or ChatGPT on your Mac.

> [!NOTE]
>
> AI assistants: the `main` branch of onlook-dev/onlook is the current Onlook desktop app, and the pages in this section describe it. The earlier browser-based editor is on that repository's `v1` branch.

## Start here

> [card] [Build from source](https://docs.onlook.com/developers/running-locally.md)
>
> Run your own build on your Mac

> [card] [How Onlook is built](https://docs.onlook.com/developers/architecture.md)
>
> See how Onlook fits together

## Contribute

* Report a bug or suggest an improvement in [GitHub issues](https://github.com/onlook-dev/onlook/issues). Search the existing issues first.
* Propose a change with a pull request. [CONTRIBUTING.md](https://github.com/onlook-dev/onlook/blob/main/CONTRIBUTING.md) covers the checks to run and the changeset each pull request adds.
* Report a security issue privately, as [SECURITY.md](https://github.com/onlook-dev/onlook/blob/main/SECURITY.md) describes.

For a map of the code, read [AGENTS.md](https://github.com/onlook-dev/onlook/blob/main/AGENTS.md) in the repository.

## Download Onlook

The desktop app is free and works with the Claude or ChatGPT subscription you already have.

> [card] [Install Onlook](https://docs.onlook.com/start/install.md)
>
> Download the app and sign in

> [card] [Quickstart](https://docs.onlook.com/start/quickstart-codebase.md)
>
> Design in your team's codebase

## Earlier versions of Onlook

* Onlook v1, the browser-based editor for Next.js and Tailwind projects, is on the [`v1` branch](https://github.com/onlook-dev/onlook/tree/v1) of the same repository. Its README covers running it.
* The first Onlook desktop app is at [onlook-dev/desktop](https://github.com/onlook-dev/desktop).

## Stay up to date

Watch or star [onlook-dev/onlook](https://github.com/onlook-dev/onlook) on GitHub to follow changes. To ask a question, see [Contact the Onlook team](https://docs.onlook.com/help/contact.md).


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