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

3.8 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 untuk OpenPencil — kendalikan alat desain dari terminal Anda.

Instalasi

npm install -g @zseven-w/openpencil

Dukungan Platform

CLI secara otomatis mendeteksi dan meluncurkan aplikasi desktop OpenPencil di semua platform:

Platform	Jalur instalasi yang terdeteksi
macOS	`/Applications/OpenPencil.app`, `~/Applications/OpenPencil.app`
Windows	NSIS per-pengguna (`%LOCALAPPDATA%`), per-mesin (`%PROGRAMFILES%`), portabel
Linux	`/usr/bin`, `/usr/local/bin`, `~/.local/bin`, AppImage (`~/Applications`, `~/Downloads`), Snap, Flatpak

Penggunaan

op <perintah> [opsi]

Metode Input

Argumen yang menerima JSON atau DSL dapat diberikan dengan tiga cara:

op design '...'              # String inline (data kecil)
op design @design.txt        # Baca dari file (disarankan untuk desain besar)
cat design.txt | op design - # Baca dari stdin (piping)

Kontrol Aplikasi

op start [--desktop|--web]   # Jalankan OpenPencil (desktop secara default)
op stop                      # Hentikan instance yang berjalan
op status                    # Periksa apakah sedang berjalan

Desain (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>

Operasi Dokumen

op open [file.op]            # Buka file atau hubungkan ke kanvas langsung
op save <file.op>            # Simpan dokumen saat ini
op get [--type X] [--name Y] [--id Z] [--depth N]
op selection                 # Dapatkan seleksi kanvas saat ini

Manipulasi Node

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]

Variabel & Tema

op vars                      # Dapatkan variabel
op vars:set <json>           # Atur variabel
op themes                    # Dapatkan tema
op themes:set <json>         # Atur tema
op theme:save <file.optheme> # Simpan preset tema
op theme:load <file.optheme> # Muat preset tema
op theme:list [dir]          # Daftar preset tema

Halaman

op page list                 # Daftar halaman
op page add [--name N]       # Tambah halaman
op page remove <id>          # Hapus halaman
op page rename <id> <name>   # Ganti nama halaman
op page reorder <id> <index> # Urutkan ulang halaman
op page duplicate <id>       # Duplikasi halaman

Impor

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

Tata Letak

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

Flag Global

--file <path>     File .op target (default: kanvas langsung)
--page <id>       ID halaman target
--pretty          Output JSON yang mudah dibaca
--help            Tampilkan bantuan
--version         Tampilkan versi

Lisensi

MIT

3.8 KiB Raw Permalink Blame History