Skip to content

Environment Commands

Commands for managing and operating within ComfyUI environments.

create

Usage:

cg create [-h] [--template TEMPLATE] [--python PYTHON]
                 [--comfyui COMFYUI] [--torch-backend BACKEND] [--use] [-y]
                 name

Arguments:

  • name - Environment name

Options:

  • --template - Template manifest
  • --python - Python version (default: 3.11)
  • --comfyui - ComfyUI version
  • --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 active environment after creation (default: False)
  • -y, --yes - Skip confirmation prompts, use defaults for workspace initialization (default: False)

use

Usage:

cg use [-h] name

Arguments:

  • name - Environment name

delete

Usage:

cg delete [-h] [-y] name

Arguments:

  • name - Environment name

Options:

  • -y, --yes - Skip confirmation (default: False)

env-config

Manage environment-specific configuration.

Usage:

cg env-config [-h] {torch-backend} ...

Subcommands

torch-backend

Manage PyTorch backend settings for this environment.

Usage:

cg env-config torch-backend [-h] {show,set,detect} ...

show

Show current PyTorch backend setting.

Usage:

cg env-config torch-backend show [-h]

set

Set PyTorch backend for this environment.

Usage:

cg env-config torch-backend set [-h] backend

Arguments:

  • backend - Backend to set (e.g., cu128, cpu, rocm6.3, xpu)

detect

Auto-detect and show recommended backend using uv probe.

Usage:

cg env-config torch-backend detect [-h]

run

Usage:

cg run [-h] [--no-sync] [--torch-backend BACKEND] [-- COMFYUI_ARGS...]

Options:

  • --no-sync - Skip environment sync before running (default: False)
  • --torch-backend BACKEND - PyTorch backend override (one-time, not saved). Examples: cpu, cu128, cu126, rocm6.3, xpu. Reads from .pytorch-backend file if not specified.

Note: Arguments after -- are passed directly to ComfyUI (e.g., cg run -- --port 8189)

sync

Sync environment packages and dependencies to match pyproject.toml.

Usage:

cg sync [-h] [--torch-backend BACKEND] [-v]

Options:

  • --torch-backend BACKEND - PyTorch backend override (one-time, not saved). Examples: cpu, cu128, cu126, rocm6.3, xpu. Reads from .pytorch-backend file if not specified.
  • -v, --verbose - Show full UV output during sync (default: False)

status

Usage:

cg status [-h] [-v]

Options:

  • -v, --verbose - Show full details (default: False)

manifest

Usage:

cg manifest [-h] [--pretty] [--section SECTION]

Options:

  • --pretty - Output as YAML instead of TOML (default: False)
  • --section - Show specific section (e.g., tool.comfygit.nodes)

repair

Usage:

cg repair [-h] [-y] [--models {all,required,skip}]

Options:

  • -y, --yes - Skip confirmation (default: False)
  • --models - Model download strategy: all (default), required only, or skip (choices: all, required, skip) (default: all)

log

Usage:

cg log [-h] [-v]

Options:

  • -v, --verbose - Show full details (default: False)

commit

Usage:

cg commit [-h] [-m MESSAGE] [--auto] [--allow-issues]

Options:

  • -m, --message - Commit message (auto-generated if not provided)
  • --auto - Auto-resolve issues without interaction (default: False)
  • --allow-issues - Allow committing workflows with unresolved issues (default: False)

rollback

Usage:

cg rollback [-h] [-y] [--force] [target]

Arguments:

  • target - Version to rollback to (e.g., 'v1', 'v2') - leave empty to discard uncommitted changes (optional)

Options:

  • -y, --yes - Skip confirmation (default: False)
  • --force - Force rollback, discarding uncommitted changes without error (default: False)

pull

Usage:

cg pull [-h] [-r REMOTE] [--models {all,required,skip}] [--force]

Options:

  • -r, --remote - Git remote name (default: origin) (default: origin)
  • --models - Model download strategy (default: all) (choices: all, required, skip) (default: all)
  • --force - Discard uncommitted changes and force pull (default: False)

push

Usage:

cg push [-h] [-r REMOTE] [--force]

Options:

  • -r, --remote - Git remote name (default: origin) (default: origin)
  • --force - Force push using --force-with-lease (overwrite remote) (default: False)

reset

Reset current HEAD to specified state.

Usage:

cg reset [-h] [--hard] [--mixed] [--soft] [-y] [ref]

Arguments:

  • ref - Commit to reset to (default: HEAD)

Options:

  • --hard - Discard all changes (hard reset) (default: False)
  • --mixed - Keep changes in working tree, unstage (default) (default: False)
  • --soft - Keep changes staged (default: False)
  • -y, --yes - Skip confirmation (default: False)

switch

Switch to a branch.

Usage:

cg switch [-h] [-c] branch

Arguments:

  • branch - Branch name to switch to

Options:

  • -c, --create - Create branch if it doesn't exist (default: False)

merge

Merge branch into current.

Usage:

cg merge [-h] [-m MESSAGE] [--preview] [--auto-resolve {mine,theirs}] branch

Arguments:

  • branch - Branch to merge

Options:

  • -m, --message - Merge commit message
  • --preview - Preview changes without applying (read-only diff with conflict detection) (default: False)
  • --auto-resolve - Auto-resolve conflicts: 'mine' keeps local, 'theirs' takes incoming (choices: mine, theirs)

revert

Create new commit that undoes previous commit.

Usage:

cg revert [-h] commit

Arguments:

  • commit - Commit to revert

remote

Usage:

cg remote [-h] {add,remove,list} ...

Subcommands

add

Usage:

cg remote add [-h] name url

Arguments:

  • name - Remote name (e.g., origin)
  • url - Remote URL

remove

Usage:

cg remote remove [-h] name

Arguments:

  • name - Remote name to remove

list

Usage:

cg remote list [-h]

py

Usage:

cg py [-h] {add,remove,remove-group,list,uv} ...

Subcommands

add

Usage:

cg py add [-h] [-r REQUIREMENTS] [--upgrade] [--group GROUP] [--dev]
                 [--editable] [--bounds {lower,major,minor,exact}]
                 [packages ...]

Arguments:

  • packages - Package specifications (e.g., requests>=2.0.0) (multiple values allowed)

Options:

  • -r, --requirements - Add packages from requirements.txt file
  • --upgrade - Upgrade existing packages (default: False)
  • --group - Add to dependency group (e.g., optional-cuda)
  • --dev - Add to dev dependencies (default: False)
  • --editable - Install as editable (for local development) (default: False)
  • --bounds - Version specifier style (choices: lower, major, minor, exact)

remove

Usage:

cg py remove [-h] [--group GROUP] packages [packages ...]

Arguments:

  • packages - Package names to remove (multiple values allowed)

Options:

  • --group - Remove packages from dependency group instead of main dependencies

remove-group

Usage:

cg py remove-group [-h] group

Arguments:

  • group - Dependency group name to remove

list

Usage:

cg py list [-h] [--all]

Options:

  • --all - Show all dependencies including dependency groups (default: False)

uv

Usage:

cg py uv ...

Arguments:

  • uv_args - UV command and arguments (e.g., 'add --group optional-cuda sageattention')

constraint

Usage:

cg constraint [-h] {add,list,remove} ...

Subcommands

add

Usage:

cg constraint add [-h] packages [packages ...]

Arguments:

  • packages - Package specifications (e.g., torch==2.4.1) (multiple values allowed)

list

Usage:

cg constraint list [-h]

remove

Usage:

cg constraint remove [-h] packages [packages ...]

Arguments:

  • packages - Package names to remove (multiple values allowed)