Skip to content

Global Commands

Workspace-level commands that operate on the entire ComfyDock workspace.

init

Usage:

cfd init [-h] [--models-dir MODELS_DIR] [--yes] [path]

Arguments:

  • path - Workspace directory (default: ~/comfydock) (optional)

Options:

  • --models-dir - Path to existing models directory to index
  • --yes, -y - Use all defaults, no interactive prompts (default: False)

list

Usage:

cfd list [-h]

import

Usage:

cfd import [-h] [--name NAME] [--branch BRANCH]
                  [--torch-backend BACKEND] [--use]
                  [path]

Arguments:

  • path - Path to .tar.gz file or git repository URL (use #subdirectory for subdirectory imports) (optional)

Options:

  • --name - Name for imported environment (skip prompt)
  • --branch, -b - Git branch, tag, or commit to import (git imports only)
  • --torch-backend - PyTorch backend. Examples: auto (detect GPU), cpu, cu128 (CUDA 12.8), cu126, cu124, rocm6.3 (AMD), xpu (Intel). Default: auto (default: auto)
  • --use - Set imported environment as active (default: False)

export

Usage:

cfd export [-h] [--allow-issues] [path]

Arguments:

  • path - Path to output file (optional)

Options:

  • --allow-issues - Skip confirmation if models are missing source URLs (default: False)

model

Usage:

cfd model [-h] {index,download,add-source} ...

Subcommands

index

Usage:

cfd model index [-h] {find,list,show,status,sync,dir} ...

Subcommands

find

Usage:

cfd model index find [-h] query

Arguments:

  • query - Search query (hash prefix or filename)

list

Usage:

cfd model index list [-h]

show

Usage:

cfd model index show [-h] identifier

Arguments:

  • identifier - Model hash, hash prefix, filename, or path

status

Usage:

cfd model index status [-h]

sync

Usage:

cfd model index sync [-h]

dir

Usage:

cfd model index dir [-h] path

Arguments:

  • path - Path to models directory

download

Usage:

cfd model download [-h] [--path PATH] [-c CATEGORY] [-y] url

Arguments:

  • url - Model download URL (Civitai, HuggingFace, or direct)

Options:

  • --path - Target path relative to models directory (e.g., checkpoints/model.safetensors)
  • -c, --category - Model category for auto-path (e.g., checkpoints, loras, vae)
  • -y, --yes - Skip path confirmation prompt (default: False)

add-source

Usage:

cfd model add-source [-h] [model] [url]

Arguments:

  • model - Model filename or hash (omit for interactive mode) (optional)
  • url - Download URL (optional)

registry

Usage:

cfd registry [-h] {status,update} ...

Subcommands

status

Usage:

cfd registry status [-h]

update

Usage:

cfd registry update [-h]

config

Usage:

cfd config [-h] [--civitai-key CIVITAI_KEY] [--show]

Options:

  • --civitai-key - Set Civitai API key (use empty string to clear)
  • --show - Show current configuration (default: False)

logs

Usage:

cfd logs [-h] [-n LINES] [--level {DEBUG,INFO,WARNING,ERROR}] [--full]
                [--workspace]

Options:

  • -n, --lines - Number of lines to show (default: 200) (default: 200)
  • --level - Filter by log level (choices: DEBUG, INFO, WARNING, ERROR)
  • --full - Show all logs (no line limit) (default: False)
  • --workspace - Show workspace logs instead of environment logs (default: False)

completion

Usage:

cfd completion [-h] {install,uninstall,status} ...

Subcommands

install

Usage:

cfd completion install [-h]

uninstall

Usage:

cfd completion uninstall [-h]

status

Usage:

cfd completion status [-h]