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.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

OpenPencil 用 CLI — ターミナルからデザインツールを操作できます。

インストール

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 <command> [options]

入力方法

JSON または DSL を受け付ける引数は、3 つの方法で渡すことができます：

op design '...'              # インライン文字列（小さなペイロード向け）
op design @design.txt        # ファイルから読み込み（大きなデザインに推奨）
cat design.txt | op design - # 標準入力から読み込み（パイプ）

アプリ制御

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

4.4 KiB Raw Permalink Blame History Unescape Escape