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

Kayshen-X c4e5359596 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

5 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 для OpenPencil — управляйте инструментом дизайна из терминала.

Установка

npm install -g @zseven-w/openpencil

Поддержка платформ

CLI автоматически обнаруживает и запускает настольное приложение OpenPencil на всех платформах:

Платформа	Обнаруживаемые пути установки
macOS	`/Applications/OpenPencil.app`, `~/Applications/OpenPencil.app`
Windows	NSIS для пользователя (`%LOCALAPPDATA%`), для машины (`%PROGRAMFILES%`), портативная версия
Linux	`/usr/bin`, `/usr/local/bin`, `~/.local/bin`, AppImage (`~/Applications`, `~/Downloads`), Snap, Flatpak

Использование

op <команда> [параметры]

Методы ввода

Аргументы, принимающие JSON или DSL, можно передать тремя способами:

op design '...'              # Встроенная строка (небольшие данные)
op design @design.txt        # Чтение из файла (рекомендуется для больших дизайнов)
cat design.txt | op design - # Чтение из stdin (через конвейер)

Управление приложением

op start [--desktop|--web]   # Запустить OpenPencil (по умолчанию — настольное приложение)
op stop                      # Остановить запущенный экземпляр
op status                    # Проверить, запущено ли приложение

Дизайн (пакетный 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>

Операции с документом

op open [file.op]            # Открыть файл или подключиться к активному холсту
op save <file.op>            # Сохранить текущий документ
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Получить текущее выделение на холсте

Работа с узлами

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]

Переменные и темы

op vars                      # Получить переменные
op vars:set <json>           # Задать переменные
op themes                    # Получить темы
op themes:set <json>         # Задать темы
op theme:save <file.optheme> # Сохранить пресет темы
op theme:load <file.optheme> # Загрузить пресет темы
op theme:list [dir]          # Список пресетов тем

Страницы

op page list                 # Список страниц
op page add [--name N]       # Добавить страницу
op page remove <id>          # Удалить страницу
op page rename <id> <name>   # Переименовать страницу
op page reorder <id> <index> # Изменить порядок страницы
op page duplicate <id>       # Дублировать страницу

Импорт

op import:svg <file.svg>     # Импортировать SVG-файл
op import:figma <file.fig>   # Импортировать файл Figma .fig

Макет

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

Глобальные флаги

--file <path>     Целевой файл .op (по умолчанию: активный холст)
--page <id>       ID целевой страницы
--pretty          Читаемый вывод JSON
--help            Показать справку
--version         Показать версию

Лицензия

MIT

5 KiB Raw Blame History Unescape Escape