Erste Schritte

Webversion

OpenPencil läuft direkt im Browser und muss nicht installiert werden. Öffnen Sie app.openpencil.dev, um mit der Gestaltung zu beginnen.

Wenn Sie ein eigenes Produkt auf OpenPencil aufbauen möchten, lesen Sie den Bereich Automatisierung und die Dokumentation zum Vue SDK.

Desktop-Anwendung

Fertige Versionen für macOS, Windows und Linux finden Sie auf der Release-Seite.

Plattform	Datei
macOS (Apple Silicon)	.dmg (aarch64)
macOS (Intel)	.dmg (x64)
Windows (x64)	.msi / .exe
Windows (ARM)	.msi / .exe
Linux (x64)	.AppImage / .deb

Installation unter macOS mit Homebrew

brew install --cask openpencil

Der Befehl installiert die signierte App für Macs mit Apple Silicon oder Intel-Prozessor aus dem offiziellen Homebrew-Katalog. Updates werden von Homebrew geprüft und können später als GitHub-Releases erscheinen. Bis dahin steht der direkte Download bereit. Die CLI wird separat installiert: npm install -g @open-pencil/cli.

Wenn du den archivierten eigenen Tap verwendet hast, wechsle so:

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

Aus dem Quellcode erstellen

Voraussetzungen

• Bun als Runtime und Package Manager;
• Rust nur für die Tauri-Anwendung.

Installation

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

Entwicklungsserver

bun run dev

Der Editor ist anschließend unter http://localhost:1420 erreichbar.

Befehle

Befehl	Zweck
bun run dev	Entwicklungsserver mit HMR starten
bun run build	Produktionsversion erstellen
bun run check	oxlint und Typprüfung mit tsgo ausführen
bun run test	E2E- und visuelle Regressionstests mit Playwright ausführen
bun run test:update	Referenz-Screenshots aktualisieren
bun run test:unit	Unit-Tests mit bun:test ausführen
bun run docs:dev	Entwicklungsserver der Dokumentation starten
bun run docs:build	Dokumentation schnell zur lokalen Prüfung erstellen
bun run docs:build:production	Vollständige veröffentlichungsfähige Dokumentation einschließlich LLM-Dateien erstellen

Tauri-Anwendung

Zum Erstellen der Tauri-Anwendung werden Rust und plattformspezifische Systemkomponenten benötigt.

macOS

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

Windows

1. Installieren Sie Rust mit der Toolchain stable-msvc:

   rustup default stable-msvc

2. Installieren Sie die Visual Studio Build Tools mit der Workload Desktop development with C++.
3. WebView2 ist in Windows 10 ab Version 1803 und in Windows 11 bereits enthalten.
4. Führen Sie Folgendes aus:

   bun run tauri dev

Linux

Installieren Sie unter Debian oder Ubuntu die Systemabhängigkeiten:

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

Führen Sie anschließend aus:

bun run tauri dev

Installationspaket erstellen

bun run tauri build                                    # Aktuelle Plattform
bun run tauri build --target universal-apple-darwin    # Universal Binary für macOS