openpencil/README.ja.md
Kayshen Xu b4d1d2a7bb
V0.5.1 (#77)
* fix(docker): support multi-platform builds and fix monorepo paths

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* perf(renderer): cache pre-rasterized paragraph images to avoid per-frame glyph rasterization   (#76)

* fix(canvas): stabilize frame label size during zoom

  Draw frame labels in screen-space after the viewport transform
  restore, converting scene coords manually. Previously fontSize=12/zoom
  fed into Math.ceil caused integer-boundary jumps that made labels
  flicker during zoom. Also skip shadow rendering while actively
  zooming for smoother performance.

* perf(renderer): cache pre-rasterized paragraph images to avoid per-frame glyph rasterization

   - Add paraImageCache (SkImage, 128 MB LRU limit) keyed on the same key as paraCache
   - Use drawImageRect instead of drawParagraph on cache hit, skipping per-frame glyph shaping and rasterization
   - Fall back to direct drawParagraph only when off-screen surface creation (MakeSurface) fails
   - Extract _dpr getter to deduplicate device-pixel-ratio resolution logic across draw paths
   - Evict oldest entries when cache exceeds byte limit; delete SkImage on eviction and dispose()

* feat(cli): introduce OpenPencil CLI for terminal control of the design tool

- Added a new CLI application under `apps/cli` to manage OpenPencil from the terminal.
- Implemented commands for app control (`start`, `stop`, `status`), document operations (`open`, `save`, `get`, `selection`), and design manipulation (`design`, `import`).
- Enhanced documentation with usage instructions and platform support details.
- Updated build scripts to include CLI compilation and publishing processes.
- Introduced a new GitHub Actions workflow for publishing the CLI to npm.
- Updated existing workflows to integrate CLI build steps and ensure proper versioning across packages.

* docs: update README files to include CLI tool details and multi-platform code export

- Added CLI section to README files in multiple languages, detailing commands for terminal control of the design tool.
- Included instructions for global installation and usage examples for the CLI.
- Expanded documentation on multi-platform code export capabilities from a single `.op` file to various frameworks.
- Updated CLAUDE.md to reference the new CLI documentation and its integration with the design tool.

* chore(bun.lock): update package dependencies to specific versions

- Removed workspace references for several packages in the bun.lock file.
- Updated dependencies for `@zseven-w/pen-core`, `@zseven-w/pen-types`, `@zseven-w/pen-codegen`, `@zseven-w/pen-figma`, and `@zseven-w/pen-renderer` to version `0.5.1-beta.1`.
- Ensured consistency in dependency management across the project.

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: leinaldo <60176594+leinaldo@users.noreply.github.com>
2026-03-23 21:20:59 +08:00

18 KiB
Raw Blame History

OpenPencil

OpenPencil

世界初のオープンソース AI ネイティブベクターデザインツール。
並行エージェントチーム • Design-as-Code • 内蔵 MCP サーバー • マルチモデルインテリジェンス

English · 简体中文 · 繁體中文 · 日本語 · 한국어 · Français · Español · Deutsch · Português · Русский · हिन्दी · Türkçe · ไทย · Tiếng Việt · Bahasa Indonesia

Stars License CI Discord


OpenPencil — click to watch demo

画像をクリックしてデモ動画を視聴


Why OpenPencil

🎨 プロンプト → キャンバス

自然言語で任意の UI を記述。ストリーミングアニメーションでリアルタイムに無限キャンバス上に表示。要素を選択してチャットすることで既存のデザインを修正。

🤖 並行エージェントチーム

オーケストレーターが複雑なページを空間的なサブタスクに分解。複数の AI エージェントがヒーロー、機能紹介、フッターなど異なるセクションを同時に処理し、すべてが並列でストリーミング。

🧠 マルチモデルインテリジェンス

各モデルの能力に自動適応。Claude にはシンキング付きフルプロンプト、GPT-4o/Gemini ではシンキングを無効化、小規模モデルMiniMax、Qwen、Llamaには信頼性の高い出力のために簡略化プロンプトを使用。

🔌 MCP サーバー

Claude Code、Codex、Gemini、OpenCode、Kiro、Copilot CLI にワンクリックでインストール。ターミナルからデザイン — MCP 対応エージェントを通じて .op ファイルの読み取り、作成、編集が可能。

📦 Design-as-Code

.op ファイルは JSON — 人間が読みやすく、Git フレンドリーで差分比較可能。デザイン変数は CSS カスタムプロパティを生成。React + Tailwind または HTML + CSS へのコードエクスポート。

🖥️ どこでも動作

Web アプリ + Electron による macOS・Windows・Linux ネイティブデスクトップ。GitHub Releases からの自動アップデート。.op ファイル関連付け — ダブルクリックで開く。

⌨️ CLI — op

ターミナルからデザインツールを操作。op designop insertop export — バッチデザインDSL、ード操作、コードエクスポート。ファイルやstdinからのパイプ入力に対応。デスクトップアプリまたはWebサーバーと連携。

🎯 マルチプラットフォームコードエクスポート

1つの.opファイルからReact + Tailwind、HTML + CSS、Vue、Svelte、Flutter、SwiftUI、Jetpack Compose、React Nativeへエクスポート。デザイン変数はCSSカスタムプロパティに変換。

クイックスタート

# 依存関係をインストール
bun install

# http://localhost:3000 で開発サーバーを起動
bun --bun run dev

またはデスクトップアプリとして実行:

bun run electron:dev

前提条件: Bun >= 1.0 および Node.js >= 18

Docker

複数のイメージバリアントが利用可能です — ニーズに合ったものを選択してください:

イメージ サイズ 含まれるもの
openpencil:latest ~226 MB Web アプリのみ
openpencil-claude:latest + Claude Code CLI
openpencil-codex:latest + Codex CLI
openpencil-opencode:latest + OpenCode CLI
openpencil-copilot:latest + GitHub Copilot CLI
openpencil-gemini:latest + Gemini CLI
openpencil-full:latest ~1 GB すべての CLI ツール

実行Web のみ):

docker run -d -p 3000:3000 ghcr.io/zseven-w/openpencil:latest

AI CLI 付きで実行Claude Code

AI チャットは Claude CLI OAuth ログインに依存しています。Docker ボリュームを使用してログインセッションを永続化してください:

# ステップ 1 — ログイン(初回のみ)
docker volume create openpencil-claude-auth
docker run -it --rm \
  -v openpencil-claude-auth:/root/.claude \
  ghcr.io/zseven-w/openpencil-claude:latest claude login

# ステップ 2 — 起動
docker run -d -p 3000:3000 \
  -v openpencil-claude-auth:/root/.claude \
  ghcr.io/zseven-w/openpencil-claude:latest

ローカルビルド:

# ベースWeb のみ)
docker build --target base -t openpencil .

# 特定の CLI 付き
docker build --target with-claude -t openpencil-claude .

# フル(すべての CLI
docker build --target full -t openpencil-full .

AI ネイティブデザイン

プロンプトから UI へ

  • テキストからデザインへ — ページを説明すると、ストリーミングアニメーションでリアルタイムにキャンバス上に生成
  • オーケストレーター — 複雑なページを空間サブタスクに分解し、並列生成をサポート
  • デザイン修正 — 要素を選択し、自然言語で変更内容を記述
  • ビジョン入力 — スクリーンショットやモックアップを参照として添付してデザイン

マルチエージェントサポート

エージェント 設定方法
Claude Code 設定不要 — ローカル OAuth で Claude Agent SDK を使用
Codex CLI エージェント設定で接続(Cmd+,
OpenCode エージェント設定で接続(Cmd+,
GitHub Copilot copilot login 後、エージェント設定で接続(Cmd+,
Gemini CLI エージェント設定で接続(Cmd+,

モデル能力プロファイル — モデルの階層に応じてプロンプト、シンキングモード、タイムアウトを自動適応。フル階層モデルClaudeには完全なプロンプト、標準階層GPT-4o、Gemini、DeepSeekではシンキングを無効化、ベーシック階層MiniMax、Qwen、Llama、Mistralには最大限の信頼性のために簡略化されたネスト JSON プロンプトを使用。

MCP サーバー

  • 内蔵 MCP サーバー — Claude Code / Codex / Gemini / OpenCode / Kiro / Copilot CLI にワンクリックでインストール
  • Node.js を自動検出 — 未インストールの場合は HTTP トランスポートに自動フォールバックし、MCP HTTP サーバーを自動起動
  • ターミナルからのデザイン自動化MCP 対応エージェントを通じて .op ファイルの読み取り、作成、編集が可能
  • レイヤードデザインワークフローdesign_skeletondesign_contentdesign_refine による高忠実度マルチセクションデザイン
  • セグメント化プロンプト取得 — 必要なデザイン知識のみをロードschema、layout、roles、icons、planning など)
  • マルチページサポート — MCP ツールを通じてページの作成、名前変更、並べ替え、複製が可能

コード生成

  • React + Tailwind CSS、HTML + CSS、CSS Variables
  • Vue、Svelte、Flutter、SwiftUI、Jetpack Compose、React Native

CLI — op

グローバルインストールしてターミナルからデザインツールを操作:

npm install -g @zseven-w/openpencil
op start                     # デスクトップアプリを起動
op design @landing.txt       # ファイルからバッチデザイン
op insert '{"type":"RECT"}'  # ノードを挿入
op export react --out .      # React + Tailwind にエクスポート
op import:figma design.fig   # Figma ファイルをインポート
cat design.dsl | op design - # stdin からパイプ入力

3つの入力方法に対応インライン文字列、@filepath(ファイルから読み込み)、-stdin から読み込み)。デスクトップアプリまたは Web 開発サーバーと連携。完全なコマンドリファレンスは CLI README を参照。

機能

キャンバスと描画

  • パン、ズーム、スマートアライメントガイド、スナッピング対応の無限キャンバス
  • 矩形、楕円、直線、多角形、ペンベジェ、Frame、テキスト
  • ブーリアン演算 — 合体、型抜き、交差(コンテキストツールバー付き)
  • アイコンピッカーIconifyと画像インポートPNG/JPEG/SVG/WebP/GIF
  • オートレイアウト — 垂直/水平方向、ギャップ・パディング・justify・align 対応
  • タブナビゲーション付きマルチページドキュメント

デザインシステム

  • デザイン変数 — カラー・数値・文字列トークン、$variable 参照付き
  • マルチテーマサポート — 複数のテーマ軸、各軸に複数バリアントLight/Dark、Compact/Comfortable
  • コンポーネントシステム — インスタンスとオーバーライドを持つ再利用可能なコンポーネント
  • CSS 同期 — カスタムプロパティの自動生成、コード出力に var(--name) を使用

Figma インポート

  • レイアウト、フィル、ストローク、エフェクト、テキスト、画像、ベクターを保持して .fig ファイルをインポート

デスクトップアプリ

  • Electron によるネイティブ macOS・Windows・Linux 対応
  • .op ファイル関連付け — ダブルクリックで開く、シングルインスタンスロック
  • GitHub Releases からの自動アップデート
  • ネイティブアプリケーションメニューとファイルダイアログ

技術スタック

フロントエンド React 19 · TanStack Start · Tailwind CSS v4 · shadcn/ui
キャンバス CanvasKit/SkiaWASM、GPU アクセラレーション)
状態管理 Zustand v5
サーバー Nitro
デスクトップ Electron 35
CLI op — ターミナル制御、バッチデザインDSL、コードエクスポート
AI Anthropic SDK · Claude Agent SDK · OpenCode SDK · Copilot SDK
ランタイム Bun · Vite 7
ファイル形式 .op — JSON ベース、人間が読みやすく、Git フレンドリー

プロジェクト構成

openpencil/
├── apps/
│   ├── web/                 TanStack Start Web アプリ
│   │   ├── src/
│   │   │   ├── canvas/      CanvasKit/Skia エンジン — 描画、同期、レイアウト
│   │   │   ├── components/  React UI — エディター、パネル、共有ダイアログ、アイコン
│   │   │   ├── services/ai/ AI チャット、オーケストレーター、デザイン生成、ストリーミング
│   │   │   ├── stores/      Zustand — キャンバス、ドキュメント、ページ、履歴、AI
│   │   │   ├── mcp/         外部 CLI 統合用 MCP サーバーツール
│   │   │   ├── hooks/       キーボードショートカット、ファイルドロップ、Figma ペースト
│   │   │   └── uikit/       再利用可能なコンポーネントキットシステム
│   │   └── server/
│   │       ├── api/ai/      Nitro API — ストリーミングチャット、生成、バリデーション
│   │       └── utils/       Claude CLI、OpenCode、Codex、Copilot ラッパー
│   ├── desktop/             Electron デスクトップアプリ
│   │   ├── main.ts          ウィンドウ、Nitro フォーク、ネイティブメニュー、自動アップデーター
│   │   ├── ipc-handlers.ts  ネイティブファイルダイアログ、テーマ同期、設定 IPC
│   │   └── preload.ts       IPC ブリッジ
│   └── cli/                 CLIツール — `op` コマンド
│       ├── src/commands/    デザイン、ドキュメント、エクスポート、インポート、ノード、ページ、変数コマンド
│       ├── connection.ts    実行中アプリへのWebSocket接続
│       └── launcher.ts      デスクトップアプリまたはWebサーバーの自動検出・起動
├── packages/
│   ├── pen-types/           PenDocument モデルの型定義
│   ├── pen-core/            ドキュメントツリー操作、レイアウトエンジン、変数
│   ├── pen-codegen/         コードジェネレーターReact、HTML、Vue、Flutter、...
│   ├── pen-figma/           Figma .fig ファイルパーサーとコンバーター
│   ├── pen-renderer/        スタンドアロン CanvasKit/Skia レンダラー
│   └── pen-sdk/             アンブレラ SDK全パッケージの再エクスポート
└── .githooks/               ブランチ名からのプレコミットバージョン同期

キーボードショートカット

キー 操作 キー 操作
V 選択 Cmd+S 保存
R 矩形 Cmd+Z 元に戻す
O 楕円 Cmd+Shift+Z やり直す
L 直線 Cmd+C/X/V/D コピー/カット/ペースト/複製
T テキスト Cmd+G グループ化
F Frame Cmd+Shift+G グループ解除
P ペンツール Cmd+Shift+E エクスポート
H ハンド(パン) Cmd+Shift+C コードパネル
Del 削除 Cmd+Shift+V 変数パネル
[ / ] 重ね順の変更 Cmd+J AI チャット
矢印キー 1px 微調整 Cmd+, エージェント設定
Cmd+Alt+U ブーリアン合体 Cmd+Alt+S ブーリアン型抜き
Cmd+Alt+I ブーリアン交差

スクリプト

bun --bun run dev          # 開発サーバー(ポート 3000
bun --bun run build        # 本番ビルド
bun --bun run test         # テストの実行Vitest
npx tsc --noEmit           # 型チェック
bun run bump <version>     # すべての package.json のバージョンを同期
bun run electron:dev       # Electron 開発モード
bun run electron:build     # Electron パッケージング
bun run cli:dev            # ソースから CLI を実行
bun run cli:compile        # CLI を dist にコンパイル

コントリビュート

コントリビューションを歓迎します!アーキテクチャの詳細とコードスタイルについては CLAUDE.md をご覧ください。

  1. フォークしてクローン
  2. バージョン同期を設定:git config core.hooksPath .githooks
  3. ブランチを作成:git checkout -b feat/my-feature
  4. チェックを実行:npx tsc --noEmit && bun --bun run test
  5. Conventional Commits 形式でコミット:feat(canvas): add rotation snapping
  6. main ブランチに PR を作成

ロードマップ

  • CSS 同期付きデザイン変数とトークン
  • コンポーネントシステム(インスタンスとオーバーライド)
  • オーケストレーター付き AI デザイン生成
  • レイヤードデザインワークフロー付き MCP サーバー統合
  • マルチページサポート
  • Figma .fig インポート
  • ブーリアン演算(合体、型抜き、交差)
  • マルチモデル能力プロファイル
  • 再利用可能なパッケージによるモノレポ構成
  • CLIツールop)ターミナル制御
  • 共同編集
  • プラグインシステム

コントリビューター

Contributors

コミュニティ

Discord Discord に参加する — 質問、デザインの共有、機能のリクエストはこちら。

Star History

Star History Chart

ライセンス

MIT — Copyright (c) 2026 ZSeven-W