openpencil/apps/cli/README.pt.md
Kayshen Xu b4d1d2a7bb
V0.5.1 (#77)
* 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>
2026-03-23 21:20:59 +08:00

4 KiB

@zseven-w/openpencil

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

CLI para o OpenPencil — controle a ferramenta de design pelo seu terminal.

Instalar

npm install -g @zseven-w/openpencil

Suporte a Plataformas

A CLI detecta e inicia automaticamente o aplicativo desktop OpenPencil em todas as plataformas:

Plataforma Caminhos de instalacao detectados
macOS /Applications/OpenPencil.app, ~/Applications/OpenPencil.app
Windows NSIS por usuario (%LOCALAPPDATA%), por maquina (%PROGRAMFILES%), portatil
Linux /usr/bin, /usr/local/bin, ~/.local/bin, AppImage (~/Applications, ~/Downloads), Snap, Flatpak

Uso

op <comando> [opcoes]

Metodos de Entrada

Argumentos que aceitam JSON ou DSL podem ser passados de tres formas:

op design '...'              # String inline (payloads pequenos)
op design @design.txt        # Ler de arquivo (recomendado para designs grandes)
cat design.txt | op design - # Ler da entrada padrao (piping)

Controle do Aplicativo

op start [--desktop|--web]   # Iniciar o OpenPencil (desktop por padrao)
op stop                      # Parar a instancia em execucao
op status                    # Verificar se esta em execucao

Design (DSL em Lote)

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>

Operacoes de Documento

op open [file.op]            # Abrir arquivo ou conectar ao canvas ativo
op save <file.op>            # Salvar o documento atual
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Obter a selecao atual do canvas

Manipulacao de Nos

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]

Exportacao de Codigo

op export <format> [--out file]
# Formatos: react, html, vue, svelte, flutter, swiftui, compose, rn, css

Variaveis e Temas

op vars                      # Obter variaveis
op vars:set <json>           # Definir variaveis
op themes                    # Obter temas
op themes:set <json>         # Definir temas
op theme:save <file.optheme> # Salvar preset de tema
op theme:load <file.optheme> # Carregar preset de tema
op theme:list [dir]          # Listar presets de temas

Paginas

op page list                 # Listar paginas
op page add [--name N]       # Adicionar uma pagina
op page remove <id>          # Remover uma pagina
op page rename <id> <name>   # Renomear uma pagina
op page reorder <id> <index> # Reordenar uma pagina
op page duplicate <id>       # Duplicar uma pagina

Importacao

op import:svg <file.svg>     # Importar arquivo SVG
op import:figma <file.fig>   # Importar arquivo .fig do Figma

Layout

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

Flags Globais

--file <path>     Arquivo .op alvo (padrao: canvas ativo)
--page <id>       ID da pagina alvo
--pretty          Saida JSON legivel
--help            Mostrar ajuda
--version         Mostrar versao

Licenca

MIT