Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
{
"name": "comfyui-readable-node",
"owner": { "name": "nomadoor" },
"interface": {
"displayName": "Readable Node"
},
"owner": {
"name": "nomadoor"
},
"plugins": [
{
"name": "comfyui-readable-node",
"source": "./",
"description": "Rebuilds ComfyUI workflows into a form people can read (Readable Node)."
"description": "Rebuilds ComfyUI workflows into a form people can read (Readable Node).",
"policy": {
"installation": "AVAILABLE",
"authentication": "ON_INSTALL"
},
"category": "Productivity"
}
]
}
2 changes: 1 addition & 1 deletion .claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "comfyui-readable-node",
"version": "0.0.5",
"version": "0.1.0",
"description": "Rebuilds ComfyUI workflows into a form people can read (Readable Node).",
"author": {
"name": "nomadoor"
Expand Down
18 changes: 15 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## 0.1.0 (2026-11-08)

- A rail with one target lowers through a Reroute next to the target whenever another column stands between; the canvas no longer wires it straight from the raising Reroute, which its own check called Bad.
- "A slanted wire one move makes horizontal" no longer counts a move that takes a sampler's column of sources along (a stage's chain on the row below stays there).
- LATENT_UPSCALE_MODEL counts as a tool wire, not one a node works on.
- Two stacked nodes aligned only on their left edges are Bad (columns align their right edges); the check names the fix, `put … below` with the right edges aligned. A loader above a sampler is left alone.
- Rails keep V_GAP from nodes: a rail pushed up in type order stays V_GAP above the node heading the rail below it. New check: a rail closer to a node than V_GAP (the wire from a source to its first Reroute included).
- Tests: removed the skipped tests and the development notes.
- English uses American spelling throughout (color, neighbor, center, afterward, backward).
- README rewritten in English and Japanese, with a Simplified Chinese version (README.zh.md), the intro video, and install steps for the Claude and ChatGPT desktop apps.
- marketplace.json: the display name, install policy and category used by Codex are back.

## 0.0.5 (2026-11-08)

Layout came out worse in 0.0.4: rules lost while untangling sentences, and the canvas telling the agent fixes it could not make. This puts them back and makes the canvas and the rules agree.
Expand Down Expand Up @@ -70,10 +82,10 @@ The rules were untangled into one set: sentences that contradicted each other we
- The places the canvas offers for a Note no longer put another node between the Note and the node it explains. A raising Reroute is no longer called unneeded when the rail drawn at the output height would run too close to another rail.
- Export keeps node numbers from one export to the next; a Reroute the canvas made gets a number of its own.
- Fixed: a link from a broadcaster (Anything Everywhere) saved with the type `*` now takes the type of the output it comes from.
- A Load CLIP whose CLIP reaches no text encoder (one that only feeds an LLM) gets no fixed colour.
- A Load CLIP whose CLIP reaches no text encoder (one that only feeds an LLM) gets no fixed color.
- A wire may go back one node's width only into Conditioning Zero Out, or from an empty latent into a scheduler.
- Report page: bypassed nodes are drawn in ComfyUI's bypass colour; the Walkthrough's first page lists the parts, the review and the widened gaps.
- References: readable-form.md rewritten as eight numbered rules with Why, Bad, Fine and Undecided (the usual form, nodes, wires, flow and position, loaders, value nodes, groups and colour, names); content.md rewritten as two decisions (split; keep, fix, replace or remove); examples.md ordered by those sections; glossary.md defines chain wire, raising and lowering Reroute, gaps, step and more; notes.md: link the Comfy-Org copy of a model, suggest a smaller form of the same model when memory runs short; techniques.md: what becomes of the author's negative text at cfg 1 depends on whether raising cfg is an ordinary choice; replacements.md: `canvas open` replaces Image Comparer, braces in Format Text are doubled.
- Report page: bypassed nodes are drawn in ComfyUI's bypass color; the Walkthrough's first page lists the parts, the review and the widened gaps.
- References: readable-form.md rewritten as eight numbered rules with Why, Bad, Fine and Undecided (the usual form, nodes, wires, flow and position, loaders, value nodes, groups and color, names); content.md rewritten as two decisions (split; keep, fix, replace or remove); examples.md ordered by those sections; glossary.md defines chain wire, raising and lowering Reroute, gaps, step and more; notes.md: link the Comfy-Org copy of a model, suggest a smaller form of the same model when memory runs short; techniques.md: what becomes of the author's negative text at cfg 1 depends on whether raising cfg is an ordinary choice; replacements.md: `canvas open` replaces Image Comparer, braces in Format Text are doubled.

## 0.0.2 (2026-10-21)

Expand Down
6 changes: 3 additions & 3 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
comfyui-readable-node

This skill reads ComfyUI workflows the way the ComfyUI frontend loads them, so its reading code
reproduces the frontend's behaviour (subgraph expansion, widget value order, legacy group nodes,
node sizes). That behaviour was checked against prompts produced by the running frontend; no frontend
reproduces the frontend's behavior (subgraph expansion, widget value order, legacy group nodes,
node sizes). That behavior was checked against prompts produced by the running frontend; no frontend
source code is included.

skills/comfyui-readable-node/scripts/ue.py reproduces the link rules of the Anything Everywhere custom nodes
(cg-use-everywhere by chrisgoringe, Apache License 2.0). It was written from a description of
that behaviour; no source code of that project is included.
that behavior; no source code of that project is included.

skills/comfyui-readable-node/scripts/fonts/PlusJakartaSans-latin.woff2 is Plus Jakarta Sans (Latin subset), embedded in the replay page.
It is licensed under the SIL Open Font License 1.1; see skills/comfyui-readable-node/scripts/fonts/OFL-PlusJakartaSans.txt.
136 changes: 104 additions & 32 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,140 @@
# comfyui-readable-node
# ComfyUI Readable Node

[English](README.md)
[![English](https://img.shields.io/badge/lang-English-blue)](README.md) [![日本語](https://img.shields.io/badge/lang-%E6%97%A5%E6%9C%AC%E8%AA%9E-red)](README.ja.md) [![中文](https://img.shields.io/badge/lang-%E4%B8%AD%E6%96%87-green)](README.zh.md)

ComfyUI の workflow を、人が読みやすい形(**Readable Node**)に組み直す、エージェント向けの skill です。
[![Site](https://img.shields.io/badge/site-comfyui.nomadoor.net-orange)](https://comfyui.nomadoor.net/) [![License: MIT](https://img.shields.io/badge/license-MIT-lightgrey)](LICENSE)

1. **ノードを隠さない。** subgraph は展開し、折りたたみは開き、ノードを重ねない。
2. **線を隠さない。** 無線(Set/Get、Anything Everywhere、線の非表示など)は、線に戻す。
3. **左から右へ。** 処理の順に左から右へ流す。
4. **1 task = 1 workflow。** 1 workflow は、使う人のやりたいこと一つ。
5. **custom node はできるだけ取り除く。** core のノードで組めるものは core で組む。
6. **適切に色を付ける。** 色は、どの機能に属するかを示す。
[![ComfyUI Readable Node](https://img.youtube.com/vi/_Pkw9Mcvkng/maxresdefault.jpg)](https://youtu.be/_Pkw9Mcvkng)

ComfyUI の workflow を、読みやすい形(**Readable Node**)に組み直す skill です。

単にスクリプトでレイアウトを整えるものではありません。
AI は workflow を一度ばらばらにし、何をしているのかを理解します。その後、タスクがいくつも詰め込まれているものは 1 つずつの workflow に分け、下のルールに従って 0 から組み直します。

元の workflow がやっていることはなるべく保ちつつ、custom node を core のノードに置き換えたり、よりシンプルに組める手段があればそちらで組み直したりして、本質を変えないまま堅牢な workflow にしていきます。

もちろん、0 から AI に workflow を組んでもらうときにも役立ちます。

## Readable Node とは

ここでは「読みやすい」を、何をしているかがスッと頭に入って、安定して動いて、気軽に組み替えられること、と定義しています。
そのために必要な 6 つのルールが以下です。

1. **ノードを隠さない**<br>
subgraph は展開し、折りたたみは開き、ノードを重ねない。
2. **ワイヤを隠さない**<br>
無線(Set/Get、Anything Everywhere、ワイヤの非表示など)は、ワイヤに戻す。ノードをギチギチに詰めた、いわゆる Bento レイアウトも、ワイヤが隠れるのでやめる。
3. **左から右へ**<br>
処理の順に左から右へ流す。
4. **1 つの workflow に、1 つの作業**<br>
1 workflow は、使う人のやりたいこと一つ。
5. **カスタムノードは最小限**<br>
core のノードで組めるものは core で組む。
6. **適切な色付け**<br>
色は、どの機能に属するかを示す。

## 導入

下のどれか一つで入れてください。二つ入れると、skill が二重に並びます。
使っているアプリに合わせて、下のどれかで入れてください。

### Claude Code
※ plugin として入れたあとに npx でも入れると、skill が二重に入ってしまうので注意してください。

Claude Code のセッションの中で、次を実行してください。
<details>
<summary><b>Claude デスクトップアプリ</b></summary>

1. **プラグイン** の画面で **+追加 → マーケットプレイスを追加 → リポジトリから追加** を選ぶ
2. `nomadoor/comfyui-readable-node` を入力
3. `comfyui-readable-node` の **+** をクリック

</details>

<details>
<summary><b>Claude Code(CLI)</b></summary>

ターミナルで次を実行してください。

```bash
claude plugin install comfyui-readable-node --marketplace nomadoor/comfyui-readable-node
```
/plugin marketplace add nomadoor/comfyui-readable-node
/plugin install comfyui-readable-node@comfyui-readable-node
```

自動で更新したいときは、`/plugin` の Marketplaces で `comfyui-readable-node` を選び、Enable auto-update を選んでください。
</details>

<details>
<summary><b>ChatGPT デスクトップアプリ(Codex)</b></summary>

1. **カスタマイズ → プラグイン** で **追加** を押す
2. ソースに `https://github.com/nomadoor/comfyui-readable-node.git` を入力。Git ref とスパースパスは空のまま
3. **個人用** のタブの `comfyui-readable-node` の **+** をクリック

</details>

<details>
<summary><b>Codex CLI</b></summary>

### Codex
ターミナルで次を実行してください。

```bash
codex plugin marketplace add nomadoor/comfyui-readable-node
codex plugin add comfyui-readable-node@comfyui-readable-node
```

### そのほかのエージェント(Gemini CLI、Cursor、GitHub Copilot など)
</details>

<details>
<summary><b>そのほかのエージェント(Gemini CLI、Cursor、GitHub Copilot など)</b></summary>

ターミナルで次を実行してください。Node.js 22.20 以上が必要です。

```bash
npx skills add nomadoor/comfyui-readable-node -g
```

Node.js 22.20 以上が必要です。

scripts を動かすには Python 3 が必要です(標準ライブラリだけを使います)。

## モデル

長い作業を自分で確かめながら進める skill なので、強いモデルを使ってください。
</details>

- いちばん良いのは Claude Opus 5.5 です。
- GPT 6.1 でも使えますが、配置の崩れが残ることがあります。
- 少なくとも Sonnet 以上のモデルでないと、うまくいかないかもしれません。
skill の scripts を動かすには、Python 3 が必要です(標準ライブラリだけを使います)。

## 使い方

1. ComfyUI を起動しておいてください。skill は、動いている ComfyUI からノードの定義を読みます。
1. ComfyUI を起動しておいてください。skill は、動いている ComfyUI からノードの情報を読みます。
2. エージェントに頼んでください。たとえば:
- 「Readable Node で `my_workflow.json` を読みやすくして。ComfyUI は http://127.0.0.1:8188 で動いています。」
- 「Readable Node で、Flux の Text to Image の workflow を作って。」

確実に呼びたいときは `/comfyui-readable-node` と打ってください(plugin で入れたときは `/comfyui-readable-node:comfyui-readable-node`)。
3. 組み直した workflow(`.json`)と報告が出てきます。workflow を ComfyUI で開いて確かめてください。
3. 出来上がった workflow を ComfyUI で開いて、確かめてください。

時間は、ノード 25 個ほどの workflow で 10 分前後です。大きな workflow だと 20〜40 分かかることもあります。

## できあがるもの

<!-- before / after image goes here -->

- **組み直した workflow**: 元のファイル名に `_readable` を付けた `.json` です。元のファイルは上書きしません。
- **report.html**: ブラウザで開くと、AI が組み直していく様子と、出来上がった workflow の解説が見られます。
- Original: 元の workflow と見比べられます。
- Rebuilt: AI がノードを一手ずつ動かしていく様子を、タイムラインで再生できます。
- Walkthrough: 出来上がった workflow を、部分ごとに解説します。

## おすすめの AI モデル

workflow を読み解いて綺麗に組み直すのは、見た目に反してかなり重い作業なので、できるだけ強いモデルを使ってください。

- 開発に使っていて、いちばんおすすめなのは Claude Opus 5.5 です。
- GPT 6.1 / 6.0 Astra でも使えますが、配置の崩れが残ることがあります。

## skill が読みに行くもの

- お使いの PC で動いている ComfyUI。どんなノードが入っているかを確かめます。
- [Comfy with ComfyUI](https://comfyui.nomadoor.net/) の workflow。組み方の参考にすることがあります。

## うまくいかなかったとき

組み直した workflow がおかしい、読みにくいときは、[issue](https://github.com/nomadoor/comfyui-readable-node/issues/new/choose) で教えてください。workflow には、プロンプトやフォルダのパスが入っていることがあります。公開したくないものは消してから添付してください。

## 作者

報告のページ `report.html` も出ます。元の workflow、組み直しの手順、出来上がった workflow の説明(Walkthrough)を見られます。
[nomadoor](https://x.com/noma_door)。ComfyUI の基本を解説するサイト [Comfy with ComfyUI](https://comfyui.nomadoor.net/) を運営しています。この skill は、サイトに載せてきた 400 本を超える workflow を土台に作りました。

## ライセンス

MIT。[LICENSE](LICENSE) と [NOTICE](NOTICE) を見てください。
MIT
Loading
Loading