Getting Started

Overview

comfy-cli is a command line tool that makes it easier to install and manage Comfy.

Install CLI

pip

pip install comfy-cli

brew tap Comfy-Org/comfy-cli
brew install comfy-org/comfy-cli/comfy-cli

To get shell completion hints:

comfy --install-completion

Install ComfyUI

Create a virtual environment with any Python version greater than 3.9.

conda

conda create -n comfy-env python=3.11
conda activate comfy-env

python3 -m venv comfy-env
source comfy-env/bin/activate

Install ComfyUI

comfy install

You still need to install CUDA, or ROCm depending on your GPU.

Run ComfyUI

comfy launch

Manage Custom Nodes

comfy node install <NODE_NAME>

We use cm-cli for installing custom nodes. See the docs for more information.

Manage Models

Downloading models with comfy-cli is easy. Just run:

comfy model download <url> models/checkpoints

Contributing

We encourage contributions to comfy-cli! If you have suggestions, ideas, or bug reports, please open an issue on our GitHub repository. If you want to contribute code, fork the repository and submit a pull request.

Refer to the Dev Guide for further details.

Analytics

We track usage of the CLI to improve the user experience. You can disable this by running:

comfy tracking disable

To re-enable tracking, run:

comfy tracking enable