Skip to content

README.md

Latest commit

 

History

History
125 lines (93 loc) · 3.72 KB

README.md

File metadata and controls

125 lines (93 loc) · 3.72 KB

@zseven-w/openpencil

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

CLI for OpenPencil — control the design tool from your terminal.

Install

npm install -g @zseven-w/openpencil

Platform Support

The CLI automatically detects and launches the OpenPencil desktop app on all platforms:

Platform Installation paths detected
macOS /Applications/OpenPencil.app, ~/Applications/OpenPencil.app
Windows NSIS per-user (%LOCALAPPDATA%), per-machine (%PROGRAMFILES%), portable
Linux /usr/bin, /usr/local/bin, ~/.local/bin, AppImage (~/Applications, ~/Downloads), Snap, Flatpak

Usage

op <command> [options]

Input Methods

Arguments that accept JSON or DSL can be passed in three ways:

op design '...'              # Inline string (small payloads)
op design @design.txt        # Read from file (recommended for large designs)
cat design.txt | op design - # Read from stdin (piping)

App Control

op start [--desktop|--web]   # Launch OpenPencil (desktop by default)
op stop                      # Stop running instance
op status                    # Check if running

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>

Document Operations

op open [file.op]            # Open file or connect to live canvas
op save <file.op>            # Save current document
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Get current canvas selection

Node Manipulation

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]

Variables & Themes

op vars                      # Get variables
op vars:set <json>           # Set variables
op themes                    # Get themes
op themes:set <json>         # Set themes
op theme:save <file.optheme> # Save theme preset
op theme:load <file.optheme> # Load theme preset
op theme:list [dir]          # List theme presets

Pages

op page list                 # List pages
op page add [--name N]       # Add a page
op page remove <id>          # Remove a page
op page rename <id> <name>   # Rename a page
op page reorder <id> <index> # Reorder a page
op page duplicate <id>       # Duplicate a page

Import

op import:svg <file.svg>     # Import SVG file
op import:figma <file.fig>   # Import Figma .fig file

Layout

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

Global Flags

--file <path>     Target .op file (default: live canvas)
--page <id>       Target page ID
--pretty          Human-readable JSON output
--help            Show help
--version         Show version

License

MIT