mirror of https://github.com/ZSeven-W/openpencil.git synced 2026-05-31 19:04:29 +07:00

Kayshen-X 07ab4ca584 docs: drop op export from CLI docs and clarify pen-mcp usage

The `op export` command was removed in 0.7.x but the README still
advertised it (#116). The pen-mcp README also documented an
`npx @zseven-w/pen-mcp` quick-start that never worked because the
package ships TypeScript source against workspace-only deps with no
`bin` entry (#117).

- Strip `op export` references from all 15 root and 15 cli READMEs
- Sync AGENTS.md, CLAUDE.md, apps/cli/CLAUDE.md to match the codegen-
  pipeline reality (no standalone export command anymore)
- Rewrite pen-mcp README's quick-start: explain the package ships as
  part of the OpenPencil app and external clients connect over HTTP

Closes #116
Closes #117

2026-04-26 19:20:14 +08:00

4 KiB

Raw Permalink Blame History

@zseven-w/openpencil

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

CLI para OpenPencil — controla la herramienta de diseno desde tu terminal.

Instalacion

npm install -g @zseven-w/openpencil

Soporte de plataformas

El CLI detecta y lanza automaticamente la aplicacion de escritorio OpenPencil en todas las plataformas:

Plataforma	Rutas de instalacion detectadas
macOS	`/Applications/OpenPencil.app`, `~/Applications/OpenPencil.app`
Windows	NSIS por usuario (`%LOCALAPPDATA%`), por maquina (`%PROGRAMFILES%`), portable
Linux	`/usr/bin`, `/usr/local/bin`, `~/.local/bin`, AppImage (`~/Applications`, `~/Downloads`), Snap, Flatpak

Uso

op <comando> [opciones]

Metodos de entrada

Los argumentos que aceptan JSON o DSL se pueden pasar de tres maneras:

op design '...'              # Cadena en linea (cargas pequenas)
op design @design.txt        # Leer desde archivo (recomendado para disenos grandes)
cat design.txt | op design - # Leer desde stdin (tuberia)

Control de la aplicacion

op start [--desktop|--web]   # Iniciar OpenPencil (escritorio por defecto)
op stop                      # Detener la instancia en ejecucion
op status                    # Verificar si esta en ejecucion

Diseno (DSL por lotes)

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>

Operaciones de documento

op open [file.op]            # Abrir archivo o conectar al lienzo activo
op save <file.op>            # Guardar el documento actual
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Obtener la seleccion actual del lienzo

Manipulacion de nodos

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 y temas

op vars                      # Obtener variables
op vars:set <json>           # Establecer variables
op themes                    # Obtener temas
op themes:set <json>         # Establecer temas
op theme:save <file.optheme> # Guardar preset de tema
op theme:load <file.optheme> # Cargar preset de tema
op theme:list [dir]          # Listar presets de tema

Paginas

op page list                 # Listar paginas
op page add [--name N]       # Agregar una pagina
op page remove <id>          # Eliminar una pagina
op page rename <id> <name>   # Renombrar una pagina
op page reorder <id> <index> # Reordenar una pagina
op page duplicate <id>       # Duplicar una pagina

Importacion

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

Disposicion

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

Opciones globales

--file <path>     Archivo .op de destino (por defecto: lienzo activo)
--page <id>       ID de la pagina de destino
--pretty          Salida JSON legible
--help            Mostrar ayuda
--version         Mostrar version

Licencia

MIT

4 KiB Raw Permalink Blame History