Skip to content

Premiers pas ​

Version web ​

OpenPencil fonctionne directement dans le navigateur et ne nécessite aucune installation. Ouvrez app.openpencil.dev pour commencer à créer.

Si vous souhaitez développer votre propre produit avec OpenPencil plutôt que vous limiter à l'application par défaut, consultez la section Automatisation et la documentation du Vue SDK.

Application de bureau ​

Les versions prêtes à l'emploi pour macOS, Windows et Linux sont disponibles sur la page de téléchargement.

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

Configuration requise ​

OpenPencil affiche le rendu avec CanvasKit sur WebGL et s’appuie sur des fonctionnalités récentes de la plateforme web ; il faut donc un moteur de navigateur récent. L’application web prend en charge Chrome 111, Edge 111, Firefox 128 et Safari 16.4 ou version ultérieure ; les navigateurs basés sur Chromium, comme Brave et Opera, suivent leur version de Chrome. L’application de bureau s’affiche dans la WebView du système : le minimum dépend donc du moteur du système d’exploitation.

PlateformeConfiguration requise
macOSmacOS 13 Ventura ou version ultérieure, avec les dernières mises à jour de Safari installées (Safari 16.4 est fourni avec macOS 13.3).
WindowsWindows 10 ou version ultérieure, avec le runtime Evergreen de Microsoft Edge WebView2, qui se met à jour seul.
LinuxWebKitGTK 2.40 ou version ultérieure (webkit2gtk-4.1).

Lorsque le moteur est trop ancien, OpenPencil indique ce qu’il faut mettre à jour au lieu d’afficher une fenêtre vide. Si cet avis apparaît sur un système conforme, utilisez son lien « Report a problem », qui préremplit les informations sur le navigateur et le moteur.

Installation sous macOS avec Homebrew ​

sh
brew install --cask openpencil

Cette commande installe l’application signée pour les Mac équipés d’une puce Apple Silicon ou d’un processeur Intel depuis le catalogue officiel Homebrew. Les mises à jour sont examinées par Homebrew et peuvent arriver après les versions GitHub. En attendant, utilisez le téléchargement direct. La CLI s’installe séparément : npm install -g @open-pencil/cli.

Si vous utilisiez le tap personnalisé archivé, migrez avec :

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

Compiler le code source ​

Prérequis ​

  • Bun comme runtime et package manager ;
  • Rust uniquement pour l'application Tauri.

Installation ​

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

Serveur de développement ​

sh
bun run dev

L'éditeur sera accessible à l'adresse http://localhost:1420.

Commandes ​

CommandeRôle
bun run devDémarrer le serveur de développement avec HMR
bun run buildGénérer la version de production
bun run checkExécuter oxlint et vérifier les types avec TypeScript 7
bun run testExécuter les tests E2E et de régression visuelle avec Playwright
bun run test:updateMettre à jour les captures de référence
bun run test:unitExécuter les tests unitaires avec bun:test
bun run docs:devDémarrer le serveur de développement de la documentation
bun run docs:buildGénérer rapidement la documentation pour la vérifier en local
bun run docs:build:productionGénérer la documentation complète pour publication, y compris les fichiers destinés aux LLM

Application Tauri ​

La compilation de l'application Tauri nécessite Rust et les composants système propres à chaque plateforme.

macOS ​

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

Windows ​

  1. Installez Rust avec le toolchain stable-msvc :
    sh
    rustup default stable-msvc
  2. Installez Visual Studio Build Tools et sélectionnez le workload Desktop development with C++.
  3. WebView2 est déjà inclus dans Windows 10 à partir de la version 1803 et dans Windows 11.
  4. Exécutez :
    sh
    bun run tauri dev

Linux ​

Sous Debian ou Ubuntu, installez les dépendances système :

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

Exécutez ensuite :

sh
bun run tauri dev

Générer un package d'installation ​

sh
bun run tauri build                                    # Plateforme actuelle
bun run tauri build --target universal-apple-darwin    # Universal Binary pour macOS