Comfy-Org/comfy-cli

CLI for using ComfyUI

comfy‑cli – ComfyUI のコマンドラインマネージャー

何であるか

  • PythonベースのCLIで、オープンソースの生成メディアエンジンである ComfyUI のライフサイクル全体を自動化します(画像/動画の拡散モデル)。ComfyUIのインストール、カスタムノードの取得、モデルのダウンロード、サーバーの起動、ワークフローの実行、さらにはホストされた Comfy Cloud サービスへのジョブ送信が可能です。

主な機能

機能 機能内容
ワンコマンドインストール&起動 comfy install(または comfy setup)でComfyUIと公式マネージャーをダウンロードし、1つのコマンドで実行可能にします。
クラウド実行 comfy run … --where cloud でAPIフォーマットのワークフローをComfy Cloudに送信し、prompt_id を返却。後で結果をポーリングまたはダウンロードできます。
直接生成 comfy generate でパートナーモデル(Flux、DALL·E、Stabilityなど)をJSONワークフローを書かずに呼び出せます。
カスタムノード管理 comfy node … でノードのインストール、更新、スナップショット、バイセクト、一括更新が可能。標準の ComfyUI‑Manager フローとレジストリ直接フローの両方をサポート。
高速な依存関係解決 --fast-deps または --uv-compile で uv リゾルバを使用し、すべてのノード用の1つのロックファイルをコンパイル。インストール速度が大幅に向上。
モデル取得 1つのコマンドでCivitAI、Hugging Face、または任意のURLからモデルを取得できます。
クロスプラットフォーム Windows、macOS、Linuxで動作可能。Dockerやvirtualenv内でも実行可能。
エージェントフレンドリーな出力 --json フラグですべての応答を構造化されたエンベロープでラップ。LLMエージェント(Claude、Cursorなど)がこのツールを制御しやすくします。
シェル補完 comfy --install-completion でBash/Zsh/Fishのタブ補完を追加。
バックグラウンドサーバー管理 comfy launch --background で分離されたComfyUIインスタンスを起動。comfy env または comfy stop で一覧表示や停止が可能。
PRテスト&キャッシュ comfy launch --frontend-pr … または comfy install --pr … でGitHubのプルリクエストからUIやバックエンドを起動でき、自動キャッシュクリーンアップも実行。

一般的なワークフロー

  1. インストール – pip install comfy-cli && comfy setup(インタラクティブなウィザード)またはCI用に comfy install -y。
  2. ノード/モデルの追加 – comfy node install comfyui-impact-pack または comfy node registry-install …;comfy model download <url>。
  3. ローカル実行 – comfy launch(オプションで --background)。
  4. ワークフロー実行 – comfy run --workflow my.json(ローカル)または --where cloud を追加してホストサービスにオフロード。
  5. 監視/取得 – comfy jobs wait <id>、comfy download <id> -o ./out。
  6. 更新 – comfy update all(コア+ノード)または comfy update comfy --version latest。

なぜ重要か

  • 障壁の低減:ComfyUIを手動でセットアップするには、リポジトリのクローン、Python環境のインストール、GPU対応のPyTorchウェアラブルの処理、カスタムノードの手動取得が必要です。comfy‑cli はこれらのステップをすべて統合しています。
  • クラウドファーストのパイプラインを容易に:GPUを持たないユーザーも、単一のフラグでComfy Cloudにルーティングすることで、重い拡散モデルを実行できます。
  • 自動化を促進:JSONエンベロープと決定論的な終了コードにより、CIパイプラインやLLM駆動エージェントがインストール、更新、ジョブ送信を信頼性高くスクリプト化できます。
  • 統一された依存関係管理:uv とマネージャーの統一リゾルバを活用することで、多数のカスタムノード間のバージョン競合を早期に検出でき、時間を節約します。

インストール

# 推奨:virtualenvまたはconda環境内で
pip install comfy-cli   # Python ≥3.10
# オプション:タブ補完を有効化
comfy --install-completion

ヘルプの取得

  • comfy --help – ルートレベルのコマンド一覧。
  • comfy <サブコマンド> --help – 各アクションの詳細オプション。
  • comfy which – CLIが作用するワークスペースを表示。
  • comfy env – 現在の環境、バックグラウンドサーバー、クラウドステータスを表示。

ライセンスとコミュニティ

  • MITライセンスで配布。
  • Comfy‑Org チームによって積極的にメンテナンス。CIバッジでテストカバレッジとPyPIリリースを確認可能。

上記のすべての情報はプロジェクトのREADMEから直接取得;外部の仮定は一切追加されていません。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト