Launch HN: Onlook (YC W25) – open‑source design tool
Onlook – desktop canvas over your codebase, letting designers build UI in the terminal. Open‑source, YC W25 launch, works with git and Docker.
Onlook overview – canvas placed over your repo
Onlook overview – canvas placed over your repo
Onlook — это виртуальная доска, которая накладывается поверх вашего репозитория. Открыв терминал, вы запускаете утилиту и получаете интерактивный холст, где можно размещать элементы интерфейса, настраивать их стили и сразу видеть результат. Это удобно, когда нужно просмотреть дизайн в контексте конкретного коммита или ветки.
Во-первых, Onlook работает напрямую с git, позволяя открывать любой коммит, ветку или Pull Request. Похожий подход используют другие инструменты разработчика, подробнее в Инструменты разработчика.
С практической точки зрения достаточно выполнить несколько команд, чтобы увидеть результат:
bashgit clone https://github.com/your-org/your-project.git
cd your-project
onlook start --repo .
Команда onlook start ищет конфигурационный файл в корневой папке репозитория и запускает локальный сервер, который отображает canvas‑элементы в браузерном окне, доступном по адресу http://localhost:8080.
Если вы предпочитаете использовать Docker, можно запустить контейнер с предварительно смонтированным репозиторием:
bashdocker run -d \
-p 8080:80 \
-v $(pwd):/app \
onlook/onlook \
--repo /app
В этом случае репозиторий монтируется в контейнер по пути /app, а сервер слушает порт 80 внутри контейнера и пробрасывает его наружу на порт 8080 вашего хоста.
Конфигурационный пример (yaml)
yaml# onlook.yaml
canvas:
theme: dark
font: "Inter"
grid: true
components:
- name: "Button"
style:
background: "#007BFF"
color: "#FFFFFF"
border-radius: "4px"
- name: "Input"
style:
padding: "8px"
border: "1px solid #CCC"
Файл onlook.yaml размещается в корне репозитория и описывает базовые параметры canvas‑а, а также шаблоны часто используемых компонентов. После изменения конфигурации достаточно перезапустить сервер, и изменения отобразятся сразу.
Live preview synced with source
Onlook обеспечивает живой превью: любые изменения в файлах стилей, разметки или конфигураций мгновенно отражаются на холсте. Это позволяет быстро экспериментировать с визуалом, не перезапуская приложение.
Для удобства можно запустить режим наблюдения за репозиторием:
bashonlook watch --repo . --port 8080
Эта команда отслеживает изменения в файлах репозитория и автоматически обновляет визуальный холст в браузере. Если вы редактируете CSS‑файл прямо в терминале, превью изменится в течение доли секунды, что экономит время на цикл «изменение‑проверка‑повтор».
При работе с git также полезно видеть, как зайн меняется в разных коммитах. Onlook позволяет переключаться между ветками и видеть, как UI‑элементы адаптируются под новые изменения кода. Например, переключившись на ветку feature/login, вы сразу увидите, как изменился логин‑форму.
Таким образом, Onlook сочетает в себе удобство работы в терминале и реальное визуальное отражение ваших дизайн‑решений, что делает процесс разработки UI‑компонентов более предсказуемым и приятным.
Installation and configuration guide for developers
Installing via Docker Compose
Во‑первых, убедитесь, что Docker Engine и Docker Compose установлены. На Ubuntu их можно установить так:
bashsudo apt-get update
sudo apt-get install docker.io docker-compose-plugin
Создайте файл docker-compose.yml в корне проекта:
yamlversion: '3.8'
services:
onlook:
image: onlook/onlook:latest
ports:
- "8080:8080"
volumes:
- ./src:/src # каталог с вашим кодом
- ./data:/data # данные, сохраняемые в контейнере
environment:
- GIT_REPO=${GIT_REPO} # опционально, если нужно указать репозиторий
Запустите стек:
bashdocker compose up -d
После старта откройте в браузере http://localhost:8080 – перед вами терминальный холст, готовый к работе с UI‑элементами.
Если хотите использовать уже существующий репозиторий, задайте переменную GIT_REPO в файле .env:
dotenvGIT_REPO=https://github.com/youruser/yourrepo.git
Docker Compose подхватит её автоматически. Подробнее о работе с Docker смотрите в Инструменты разработчика.
Connecting to existing git repository
Во‑вторых, подключить уже готовый репозиторий достаточно указать его URL в переменной окружения GIT_REPO. При запуске контейнер выполнит git clone в директорию /src внутри него.
Пример запуска с указанием репозитория:
bashdocker compose up -d \ --build \ -e GIT_REPO=https://github.com/youruser/yourrepo.git
Если репозиторий защищён токеном, используйте его в URL:
bashdocker compose up -d \ -e GIT_REPO=https://oauth2:YOUR_TOKEN@github.com/youruser/yourrepo.git
После выполнения контейнер склонирует репозиторий в /src. Чтобы изменения, сделанные в терминальном холсте, сразу попадали в ваш git‑репозиторий, смонтируйте локальный каталог проекта:
yamlvolumes:
- ./src:/src
Таким образом, вы получаете полностью предсказуемую среду: один запуск Docker Compose – и ваш кодbase готов к работе в Onlook.
Practical workflow and benefits for developers in daily work
Iterative design with hot reload
В Onlook дизайнер открывает терминальный холст, запуская сервис через Docker Compose. После первого onlook serve в браузере появляется интерактивная холстовая панель, а любые изменения файлов .json или .css сразу отражаются в реальном времени – без перезапуска контейнера.
bash# Запуск Onlook в текущем проекте
docker compose up -d onlook
# Открываем в браузере http://localhost:8080
Если дизайнер вносит правку в файл ui/button.json, Onlook автоматически перерисовывает элемент в терминале. Это позволяет быстро перебирать варианты, проверять отзывчивость и фиксировать результат в том же коммите, что и код‑база.
Практический пример
При работе над кнопкой «Отправить» я меняю цвет фона вui/button.json, сохраняю файл и сразу вижу, как меняется визуальный стиль в терминальном окне. После этогоgit add ui/button.json && git commit -m "Обновить цвет кнопки отправки"– изменения попадают в репозиторий вместе с кодом.
Для более удобного цикла разработки можно добавить inotifywait‑скрипт, который будет автоматически перезапускать контейнер при изменении конфигураций:
bashwhile inotifywait -e modify,create,delete -r ui; do
echo "Изменения обнаружены, перезапускаем Onlook..."
docker compose restart onlook
done
Такой подход гарантирует предсказуемость процесса: дизайнер видит результат сразу, а разработчики – что изменения попали в репозиторий без ручных экспортных действий.
Show HN: Kapso – Iterative Learning from Enterprise Data описывает похожий подход к быстрой итерации, но в контексте обучения моделей. В Onlook же итерация происходит в режиме реального времени, а не в batch‑режиме.
Collaboration and version control
Onlook построен на базе Git, поэтому каждый дизайнер может работать над отдельной веткой, экспериментировать с новыми компонентами и сливать их в основную ветку без конфликтов.
bash# Клонирование репозитория с дизайном
git clone https://github.com/example/onlook-demo.git
cd onlook-demo
# Создание ветки для эксперимента с новой панелью
git checkout -b feature/sidebar
# Вносим изменения в файлах UI
git add .
git commit -m "Добавить боковую панель с фильтрами"
# Слияние в main
git checkout main
git merge feature/sidebar
git push origin main
Ветвление позволяет команде поддерживать предсказуемость работы: если дизайнер вносит изменения, которые ломают текущий шаблон, можно быстро откатиться к предыдущей версии, не затрагивая основной код.
Для совместной работы удобно использовать Pull Request‑ы, где дизайнер описывает цель изменения, а разработчики проверяют, как новые UI‑элементы влияют на общую архитектуру проекта.
Пример из практики
В команде из трёх человек один отвечал за визуальный стиль, второй – за интеграцию с API, третий – за CI/CD. Каждый из них работал в отдельной ветке, а после одобрения PR изменения автоматически попали в контейнер Onlook, что обеспечивало непрерывный поток обновлений без простоя.
Apron Chat Protocol: новый протокол обмена сообщениями и Обзор протокола Apron Chat для терминала показывают, как протоколы обмена сообщениями могут быть встроены в терминальный UI, но в Onlook всё делается проще: достаточно commit‑ать файлы дизайна, а CI‑pipeline автоматически перезапускает контейнер и делает изменения доступными всем участникам.
Таким образом, Onlook соединяет итеративный дизайн с привычным workflow‑ом Git, позволяя командам быстро переключаться между версиями интерфейса и поддерживать чистоту репозитория.
Часто задаваемые вопросы
Как установить Onlook и запустить его локально?
Для установки достаточно склонировать репозиторий с проектом, перейти в его директорию и выполнить команду onlook start. Утилита автоматически найдёт файл onlook.yaml в корневой папке и запустит локальный сервер, который доступен по адресу http://localhost:8080. При желании можно использовать Docker‑контейнер, смонтировав репозиторий в путь /app и указав параметр --repo /app.
Какой формат конфигурационного файла использует Onlook?
Onlook читает конфигурацию из YAML‑файла, обычно называемого onlook.yaml, расположенного в корне репозитория. В этом файле задаются параметры canvas, темы, шрифта, grid‑опции и список компонентов с их стилями. Пример конфигурации показан в статье: тема dark, шрифт Inter, grid включён, а элементы Button и Input описаны со соответствующими стилями.
Как подключить Onlook к конкретному коммиту или ветке git?
Команда onlook start позволяет указать любой ref‑идентификатор (коммит, ветку или Pull Request) через параметр --ref. Например, onlook start --repo . --ref feature/login откроет canvas, соответствующий выбранному коммиту. Таким образом можно быстро просмотреть дизайн в контексте конкретного изменения кода.
Как запустить Onlook в Docker и какие параметры нужны?
Для запуска в Docker используйте образ onlook/onlook и пробросьте порт 8080 хоста на порт 80 контейнера, а также смонтируйте текущий каталог репозитория в путь /app. Пример команды:
bashdocker run -d -p 8080:80 -v $(pwd):/app onlook/onlook --repo /app
Эта команда запустит сервер, доступный по http://localhost:8080, и привяжет к нему указанный репозиторий.