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

4.1 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 cho OpenPencil — điều khiển công cụ thiết kế từ terminal của bạn.

Cài đặt

npm install -g @zseven-w/openpencil

Hỗ trợ nền tảng

CLI tự động phát hiện và khởi chạy ứng dụng desktop OpenPencil trên tất cả các nền tảng:

Nền tảng	Đường dẫn cài đặt được phát hiện
macOS	`/Applications/OpenPencil.app`, `~/Applications/OpenPencil.app`
Windows	NSIS theo người dùng (`%LOCALAPPDATA%`), theo máy (`%PROGRAMFILES%`), di động
Linux	`/usr/bin`, `/usr/local/bin`, `~/.local/bin`, AppImage (`~/Applications`, `~/Downloads`), Snap, Flatpak

Sử dụng

op <lệnh> [tùy-chọn]

Phương thức nhập liệu

Các đối số chấp nhận JSON hoặc DSL có thể được truyền theo ba cách:

op design '...'              # Chuỗi nội tuyến (dữ liệu nhỏ)
op design @design.txt        # Đọc từ tệp (khuyến nghị cho thiết kế lớn)
cat design.txt | op design - # Đọc từ stdin (đường ống)

Điều khiển ứng dụng

op start [--desktop|--web]   # Khởi chạy OpenPencil (mặc định: desktop)
op stop                      # Dừng phiên bản đang chạy
op status                    # Kiểm tra trạng thái hoạt động

Thiết kế (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>

Thao tác tài liệu

op open [file.op]            # Mở tệp hoặc kết nối với canvas trực tiếp
op save <file.op>            # Lưu tài liệu hiện tại
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Lấy vùng chọn canvas hiện tại

Thao tác nút

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]

Biến và giao diện

op vars                      # Lấy biến
op vars:set <json>           # Đặt biến
op themes                    # Lấy giao diện
op themes:set <json>         # Đặt giao diện
op theme:save <file.optheme> # Lưu bộ giao diện mẫu
op theme:load <file.optheme> # Tải bộ giao diện mẫu
op theme:list [dir]          # Liệt kê bộ giao diện mẫu

Trang

op page list                 # Liệt kê trang
op page add [--name N]       # Thêm trang
op page remove <id>          # Xóa trang
op page rename <id> <name>   # Đổi tên trang
op page reorder <id> <index> # Sắp xếp lại trang
op page duplicate <id>       # Nhân bản trang

Nhập

op import:svg <file.svg>     # Nhập tệp SVG
op import:figma <file.fig>   # Nhập tệp Figma .fig

Bố cục

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

Cờ toàn cục

--file <path>     Tệp .op đích (mặc định: canvas trực tiếp)
--page <id>       ID trang đích
--pretty          Xuất JSON dễ đọc
--help            Hiển thị trợ giúp
--version         Hiển thị phiên bản

Giấy phép

MIT

4.1 KiB Raw Blame History