mirror of
https://github.com/ZSeven-W/openpencil.git
synced 2026-05-31 19:04:29 +07:00
b4d1d2a7bb
* fix(docker): support multi-platform builds and fix monorepo paths Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * perf(renderer): cache pre-rasterized paragraph images to avoid per-frame glyph rasterization (#76) * fix(canvas): stabilize frame label size during zoom Draw frame labels in screen-space after the viewport transform restore, converting scene coords manually. Previously fontSize=12/zoom fed into Math.ceil caused integer-boundary jumps that made labels flicker during zoom. Also skip shadow rendering while actively zooming for smoother performance. * perf(renderer): cache pre-rasterized paragraph images to avoid per-frame glyph rasterization - Add paraImageCache (SkImage, 128 MB LRU limit) keyed on the same key as paraCache - Use drawImageRect instead of drawParagraph on cache hit, skipping per-frame glyph shaping and rasterization - Fall back to direct drawParagraph only when off-screen surface creation (MakeSurface) fails - Extract _dpr getter to deduplicate device-pixel-ratio resolution logic across draw paths - Evict oldest entries when cache exceeds byte limit; delete SkImage on eviction and dispose() * feat(cli): introduce OpenPencil CLI for terminal control of the design tool - Added a new CLI application under `apps/cli` to manage OpenPencil from the terminal. - Implemented commands for app control (`start`, `stop`, `status`), document operations (`open`, `save`, `get`, `selection`), and design manipulation (`design`, `import`). - Enhanced documentation with usage instructions and platform support details. - Updated build scripts to include CLI compilation and publishing processes. - Introduced a new GitHub Actions workflow for publishing the CLI to npm. - Updated existing workflows to integrate CLI build steps and ensure proper versioning across packages. * docs: update README files to include CLI tool details and multi-platform code export - Added CLI section to README files in multiple languages, detailing commands for terminal control of the design tool. - Included instructions for global installation and usage examples for the CLI. - Expanded documentation on multi-platform code export capabilities from a single `.op` file to various frameworks. - Updated CLAUDE.md to reference the new CLI documentation and its integration with the design tool. * chore(bun.lock): update package dependencies to specific versions - Removed workspace references for several packages in the bun.lock file. - Updated dependencies for `@zseven-w/pen-core`, `@zseven-w/pen-types`, `@zseven-w/pen-codegen`, `@zseven-w/pen-figma`, and `@zseven-w/pen-renderer` to version `0.5.1-beta.1`. - Ensured consistency in dependency management across the project. --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: leinaldo <60176594+leinaldo@users.noreply.github.com>
3.8 KiB
3.8 KiB
@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]
Code Export
op export <format> [--out file]
# Formats: react, html, vue, svelte, flutter, swiftui, compose, rn, css
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