# Onlook

> Onlook is a Mac app for designers: it runs your team's real codebase on a canvas, an AI agent (Claude Code or ChatGPT) changes the code when you ask, and the result goes to your engineers as a pull request.

- [Welcome to Onlook](https://docs.onlook.com/start/welcome.md): 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.
- [Install Onlook](https://docs.onlook.com/start/install.md): Download Onlook for Mac, let macOS install the developer tools it asks for, sign in, and keep Onlook up to date.
- [Quickstart: your codebase on the canvas](https://docs.onlook.com/start/quickstart-codebase.md): Go from a folder of your team's code to your app running on the Onlook canvas, with one change made by the agent.
- [Tour the Onlook interface](https://docs.onlook.com/start/interface.md): What each part of the Onlook window is called, where it sits, and what you do there: the projects screen, top bar, sidebar, canvas, toolbar and chat.
- [Tips: learn what to ask for](https://docs.onlook.com/start/tips.md): Onlook's built-in Tips show example requests you can send to the agent, and every keyboard shortcut. Open them with ⌘/.
- [How Onlook keeps your code safe](https://docs.onlook.com/start/trust.md): Exactly what Onlook does with your codebase, and what it never does.
- [Connect your AI (Claude or ChatGPT)](https://docs.onlook.com/setup/ai.md): Set up Claude or ChatGPT as Onlook's agent, using the plan you already have, and choose how much it can do without asking.
- [Artifacts](https://docs.onlook.com/canvas/artifacts.md): Sketch a page on the canvas without touching your code: what artifacts are, how to make and change them, export them, and hand them to your codebase.
- [The git status pill](https://docs.onlook.com/handoff/the-git-status-pill.md): The pill in the top bar shows where your change is on its way to the codebase. Pressing it does the next step.
- [Create a pull request](https://docs.onlook.com/handoff/create-a-pull-request.md): Turn the work on your copy into a pull request your engineers can review, and keep it moving.
- [What your engineers see](https://docs.onlook.com/handoff/what-your-engineers-see.md): For the engineer a designer sends this to: what Onlook did to the repository, and what it didn't.
- [Onlook for developers](https://docs.onlook.com/developers/index.md): The state of Onlook's source code and developer docs: the new Mac app is being opened up in the coming weeks, and guides for running it locally are on the way.
- [Running Onlook locally](https://docs.onlook.com/developers/running-locally.md): How to build and run the Onlook desktop app from source. The guide is coming with the open-source release in the coming weeks. Until then, here's what to use instead.
- [Architecture](https://docs.onlook.com/developers/architecture.md): How the Onlook desktop app works: your app runs locally in frames, an AI agent edits a git worktree copy of your code, and changes leave as pull requests. Detailed docs come with the open-source release.
- [Frequently asked questions](https://docs.onlook.com/help/faq.md): Short answers about Onlook, the Mac app for Visual Engineers: what it is, what it does with your code, what it costs, and what it works with.
- [Troubleshooting](https://docs.onlook.com/help/troubleshooting.md): Every message Onlook can show when something goes wrong, what it means, and what to do.
- [Contact the Onlook team](https://docs.onlook.com/help/contact.md): Send a report or an idea from inside Onlook, or email us, and what to include so we can help.


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