Skip to content

Latest commit

 

History

History
125 lines (93 loc) · 3.92 KB

File metadata and controls

125 lines (93 loc) · 3.92 KB

@zseven-w/openpencil

English · 简体中文 · 繁體中文 · 日本語 · 한국어 · Français · Español · Deutsch · Português · Русский · हिन्दी · Türkçe · ไทย · Tiếng Việt · Bahasa Indonesia

CLI fuer OpenPencil — steuere das Design-Tool von deinem Terminal aus.

Installation

npm install -g @zseven-w/openpencil

Plattformunterstuetzung

Das CLI erkennt und startet die OpenPencil-Desktop-App automatisch auf allen Plattformen:

Plattform Erkannte Installationspfade
macOS /Applications/OpenPencil.app, ~/Applications/OpenPencil.app
Windows NSIS pro Benutzer (%LOCALAPPDATA%), systemweit (%PROGRAMFILES%), portabel
Linux /usr/bin, /usr/local/bin, ~/.local/bin, AppImage (~/Applications, ~/Downloads), Snap, Flatpak

Verwendung

op <Befehl> [Optionen]

Eingabemethoden

Argumente, die JSON oder DSL akzeptieren, koennen auf drei Arten uebergeben werden:

op design '...'              # Inline-Zeichenkette (kleine Nutzlasten)
op design @design.txt        # Aus Datei lesen (empfohlen fuer grosse Designs)
cat design.txt | op design - # Von stdin lesen (Piping)

App-Steuerung

op start [--desktop|--web]   # OpenPencil starten (standardmaessig Desktop)
op stop                      # Laufende Instanz beenden
op status                    # Pruefen, ob die App laeuft

Design (Batch-DSL)

op design <dsl|@file|-> [--post-process] [--canvas-width N]
op design:skeleton <json|@file|->
op design:content <section-id> <json|@file|->
op design:refine --root-id <id>

Dokumentoperationen

op open [file.op]            # Datei oeffnen oder mit aktivem Canvas verbinden
op save <file.op>            # Aktuelles Dokument speichern
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Aktuelle Canvas-Auswahl abrufen

Knotenmanipulation

op insert <json> [--parent P] [--index N] [--post-process]
op update <id> <json> [--post-process]
op delete <id>
op move <id> --parent <P> [--index N]
op copy <id> [--parent P]
op replace <id> <json> [--post-process]

Variablen und Themes

op vars                      # Variablen abrufen
op vars:set <json>           # Variablen setzen
op themes                    # Themes abrufen
op themes:set <json>         # Themes setzen
op theme:save <file.optheme> # Theme-Preset speichern
op theme:load <file.optheme> # Theme-Preset laden
op theme:list [dir]          # Theme-Presets auflisten

Seiten

op page list                 # Seiten auflisten
op page add [--name N]       # Eine Seite hinzufuegen
op page remove <id>          # Eine Seite entfernen
op page rename <id> <name>   # Eine Seite umbenennen
op page reorder <id> <index> # Eine Seite neu anordnen
op page duplicate <id>       # Eine Seite duplizieren

Import

op import:svg <file.svg>     # SVG-Datei importieren
op import:figma <file.fig>   # Figma-.fig-Datei importieren

Layout

op layout [--parent P] [--depth N]
op find-space [--direction right|bottom|left|top]

Globale Optionen

--file <path>     Ziel-.op-Datei (Standard: aktives Canvas)
--page <id>       Zielseiten-ID
--pretty          Menschenlesbare JSON-Ausgabe
--help            Hilfe anzeigen
--version         Version anzeigen

Lizenz

MIT