Skip to content

Начало работы ​

Веб-версия ​

OpenPencil работает прямо в браузере и не требует установки. Чтобы начать работу, откройте app.openpencil.dev.

Если вы хотите создать на основе OpenPencil собственный продукт, а не только пользоваться готовым приложением, перейдите в раздел Программирование и автоматизация или прочитайте документацию Vue SDK.

Приложение для компьютера ​

Готовые версии для macOS, Windows и Linux опубликованы на странице релизов.

ПлатформаФайл
macOS (Apple Silicon).dmg (aarch64)
macOS (Intel).dmg (x64)
Windows (x64).msi / .exe
Windows (ARM).msi / .exe
Linux (x64).AppImage / .deb

Установка в macOS через Homebrew ​

sh
brew install --cask openpencil

Команда устанавливает подписанное приложение для Mac с Apple Silicon или Intel из официального каталога Homebrew. Обновления проходят проверку в Homebrew и могут появляться позже релизов на GitHub. До обновления каталога используйте прямую загрузку. CLI устанавливается отдельно: npm install -g @open-pencil/cli.

Если вы использовали архивный собственный tap, перейдите так:

sh
brew uninstall open-pencil/tap/open-pencil
brew install --cask openpencil

Сборка из исходного кода ​

Что потребуется ​

  • Bun — среда выполнения и менеджер пакетов;
  • Rust — только для приложения Tauri.

Установка ​

sh
git clone https://github.com/open-pencil/open-pencil.git
cd open-pencil
bun install

Сервер для разработки ​

sh
bun run dev

Редактор будет доступен по адресу http://localhost:1420.

Команды ​

КомандаНазначение
bun run devЗапустить сервер разработки с HMR
bun run buildСобрать версию для публикации
bun run checkЗапустить oxlint и проверку типов с помощью tsgo
bun run testЗапустить сквозные тесты и сравнение внешнего вида в Playwright
bun run test:updateОбновить эталонные снимки экрана
bun run test:unitЗапустить модульные тесты с помощью bun:test
bun run docs:devЗапустить сервер разработки документации
bun run docs:buildБыстро собрать документацию для локальной проверки
bun run docs:build:productionПолностью собрать документацию для публикации, включая файлы для LLM

Приложение Tauri ​

Для сборки приложения Tauri нужны Rust и системные компоненты выбранной платформы.

macOS ​

sh
xcode-select --install
cargo install tauri-cli --version "^2"
bun run tauri dev

Windows ​

  1. Установите Rust с toolchain stable-msvc:
    sh
    rustup default stable-msvc
  2. Установите Visual Studio Build Tools и выберите workload Desktop development with C++.
  3. WebView2 уже входит в Windows 10 версии 1803 и новее, а также в Windows 11.
  4. Выполните:
    sh
    bun run tauri dev

Linux ​

В Debian или Ubuntu установите системные зависимости:

sh
sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file \
  libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev

Затем выполните:

sh
bun run tauri dev

Сборка установочного пакета ​

sh
bun run tauri build                                    # Текущая платформа
bun run tauri build --target universal-apple-darwin    # Universal binary для macOS

Released under the MIT License.