mirror of https://github.com/ZSeven-W/openpencil.git synced 2026-06-01 03:14: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

3.9 KiB

Raw Blame History

@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]

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

3.9 KiB Raw Blame History