Name	Name	Last commit message	Last commit date
parent directory ..
README.md	README.md
sync-env-to-collection.sh	sync-env-to-collection.sh

ComfyGit Scripts

Utility scripts for ComfyGit development and workflow management.

sync-env-to-collection.sh

Sync your active ComfyGit environment to an examples collection repository.

Purpose

When developing ComfyGit example environments, you want to:

Work in ComfyGit with full comfygit command support
Test workflows in actual ComfyUI
Publish finished examples to a collection repository
Preserve custom documentation (README.md) in the examples repo

This script bridges the gap between development and publishing.

What It Syncs

Whitelisted items (copied from .cec/ to examples repo):

workflows/ - All workflow JSON files
pyproject.toml - Environment definition
.python-version - Python version
.gitignore - Git ignore rules
uv.lock - Dependency lock file

Preserved items (NOT touched in examples repo):

README.md - Documentation you write in the examples repo
Any other custom files or directories

Usage

# Basic sync (stages changes, doesn't commit)
sync-env-to-collection <path-to-examples-repo>

# Sync and commit with message
sync-env-to-collection <path-to-examples-repo> -m "feat: add new workflow"

Installation

# Make script available globally
ln -s ~/path/to/comfygit/scripts/sync-env-to-collection.sh ~/bin/sync-env-to-collection
# Or add to PATH
export PATH="$PATH:~/path/to/comfygit/scripts"

Workflow Example

# 1. Create and develop environment in ComfyGit
comfygit create txt2img
comfygit activate txt2img
comfygit node add ComfyUI-Manager
comfyui  # Create workflows in web interface
comfygit commit -m "feat: initial setup"

# 2. Sync to examples repo (without commit)
sync-env-to-collection ~/comfygit-examples

# 3. Add documentation in examples repo
cd ~/comfygit-examples/txt2img
cat > README.md << 'EOF'
# Text-to-Image Example

This environment demonstrates basic text-to-image generation.

## Workflows

- `basic.json` - Simple text-to-image
- `advanced.json` - Advanced with ControlNet

## Setup

Import with:

comfygit import https://github.com/you/comfygit-examples#txt2img -n my-txt2img

EOF

# 4. Commit everything
git add txt2img
git commit -m "feat: add txt2img example with documentation"
git push origin main

# 5. Later: Update workflows in ComfyGit
comfygit activate txt2img
# Edit workflows in ComfyUI
comfygit commit -m "feat: add ControlNet workflow"

# 6. Sync updates (README preserved!)
sync-env-to-collection ~/comfygit-examples -m "feat: add ControlNet workflow"
cd ~/comfygit-examples
git push origin main

Requirements

Bash 4.0+
jq (optional, falls back to grep/sed if not installed)
Git (for examples repo tracking)

Environment Variables

COMFYGIT_HOME - ComfyGit workspace location (default: ~/.comfygit)

How It Works

Reads $COMFYGIT_HOME/.metadata/workspace.json to get active environment
Validates environment exists at $COMFYGIT_HOME/environments/<env>/.cec
Checks for uncommitted changes in .cec/ (warns but continues if user confirms)
Creates target directory <examples-repo>/<env-name> if needed
Syncs only whitelisted files/directories from .cec/
Shows git diff of changes
Optionally commits if -m provided

Name-Based Mapping

The script uses environment name as the directory name in examples repo:

ComfyGit:           Examples Repo:
txt2img       →      txt2img/
img2img       →      img2img/
video-gen     →      video-gen/

For nested structures, modify EXAMPLES_DIR in the script or use subdirectories in your examples repo path.

Edge Cases

Q: What if I have uncommitted changes in .cec? A: Script warns and asks for confirmation. You can continue to preview changes or cancel to commit first.

Q: What if the examples repo isn't a git repo? A: Sync still works, but you won't get git tracking or commit functionality.

Q: Can I sync to a subdirectory like examples/txt2img? A: Yes, just pass the full path: sync-env-to-collection ~/repo/examples

Q: What about files not in the whitelist? A: They're ignored during sync. Add them to SYNC_ITEMS array in the script if needed.

Troubleshooting

"No active environment set"

comfygit activate <environment-name>

"No workspace.json found"

# Check COMFYGIT_HOME is correct
echo $COMFYGIT_HOME
ls $COMFYGIT_HOME/.metadata/workspace.json

"jq not found" (not an error, just FYI)

# Optional: Install jq for cleaner JSON parsing
# macOS: brew install jq
# Ubuntu: apt install jq
# Script works without it using fallback parsing

Future Enhancements

Potential improvements (not yet implemented):

--dry-run flag to preview changes
--target <subdir> to override environment name mapping
Store default examples repo path in workspace config
Pre-sync validation hooks
Reverse sync (examples → .cec)

Example Workflow: Creating a ComfyGit Examples Collection

Complete walkthrough of creating and maintaining a collection of ComfyGit example environments.

Initial Setup

1. Create Examples Repository

# Create and initialize examples repository
mkdir ~/comfygit-examples
cd ~/comfygit-examples

git init
git remote add origin git@github.com:yourusername/comfygit-examples.git

# Create main README
cat > README.md << 'EOF'
# ComfyGit Examples

Collection of ready-to-use ComfyUI environment examples.

## Available Examples

- [txt2img](txt2img/) - Text-to-image generation workflows
- [img2img](img2img/) - Image-to-image transformation
- [video-gen](video-gen/) - Video generation with AnimateDiff

## Usage

Import any example with:

```bash
comfygit import https://github.com/yourusername/comfygit-examples#<example-name> -n my-env

For example:

comfygit import https://github.com/yourusername/comfygit-examples#txt2img -n my-txt2img

EOF

git add README.md git commit -m "docs: initial README" git push -u origin main


### 2. Install Sync Script

```bash
# Make script globally available
ln -s ~/projects/comfygit/scripts/sync-env-to-collection.sh ~/bin/sync-env-to-collection
chmod +x ~/bin/sync-env-to-collection

# Test it's accessible
which sync-env-to-collection

Creating Your First Example

Step 1: Develop in ComfyGit

# Create environment
comfygit create txt2img
comfygit activate txt2img

# Add nodes you need
comfygit node add ComfyUI-Manager
comfygit node add https://github.com/pythongosssss/ComfyUI-Custom-Scripts

# Download models
comfygit model download "sd_xl_base_1.0.safetensors"

# Test in ComfyUI
comfyui
# Create and test your workflows in the web interface
# Save workflows in ComfyUI (they auto-save to .cec/workflows/)

# Commit your work
comfygit commit -m "feat: initial txt2img setup"

Step 2: Sync to Examples Repo

# Sync without committing (preview first)
sync-env-to-collection ~/comfygit-examples

# You'll see:
# ✓ Active environment: txt2img
# ✓ Content synced
# 📝 Changes detected:
#  ?? txt2img/
# ℹ️  Changes ready. To commit: ...

Step 3: Add Documentation

# Go to examples repo
cd ~/comfygit-examples/txt2img

# Create README for this example
cat > README.md << 'EOF'
# Text-to-Image Example

Basic text-to-image generation using SDXL.

## Included Workflows

### basic-txt2img.json
Simple text-to-image generation with minimal settings.

**Usage:**
1. Load workflow in ComfyUI
2. Edit the positive prompt
3. Queue prompt

### advanced-txt2img.json
Advanced workflow with:
- Multiple samplers comparison
- ControlNet integration
- Upscaling post-processing

## Requirements

- SDXL base model (auto-downloaded on import)
- 8GB+ VRAM recommended

## Import

```bash
comfygit import \
  https://github.com/yourusername/comfygit-examples#txt2img \
  -n my-txt2img

Nodes Used

ComfyUI-Manager - Node management
ComfyUI-Custom-Scripts - Quality of life improvements

All nodes automatically installed on import. EOF

Check what we have

ls -la

Output:

.gitignore

.python-version

pyproject.toml

README.md (your documentation)

uv.lock

workflows/


### Step 4: Commit and Push

```bash
# Back to repo root
cd ~/comfygit-examples

# Review all changes
git status
git diff txt2img

# Commit everything
git add txt2img
git commit -m "feat: add txt2img example with documentation"
git push origin main

# Now users can import your example!

Adding More Examples

Create Second Example

# Create in ComfyGit
comfygit create img2img
comfygit activate img2img

# Set it up
comfygit node add ComfyUI-Advanced-ControlNet
# ... develop workflows ...
comfygit commit -m "feat: img2img setup"

# Sync and commit in one step
sync-env-to-collection ~/comfygit-examples -m "feat: add img2img example"

# Add README
cd ~/comfygit-examples/img2img
vim README.md

# Update main index
cd ~/comfygit-examples
# (README.md already lists img2img)
git add .
git commit -m "docs: add img2img README"
git push origin main

Updating Existing Examples

Scenario: Add New Workflow to txt2img

# Switch to environment
comfygit activate txt2img

# Create new workflow in ComfyUI
comfyui
# ... create advanced-controlnet.json workflow ...

# Commit in ComfyGit
comfygit commit -m "feat: add ControlNet workflow"

# Sync to examples (README preserved!)
sync-env-to-collection ~/comfygit-examples -m "feat: add ControlNet workflow to txt2img"

# Optionally update README
cd ~/comfygit-examples/txt2img
# Edit README.md to document new workflow
vim README.md

cd ~/comfygit-examples
git add txt2img/README.md
git commit -m "docs: document ControlNet workflow"
git push origin main

Scenario: Update Dependencies

comfygit activate txt2img

# Add new node
comfygit node add https://github.com/new/node

# Update pyproject.toml
comfygit commit -m "feat: add new node dependency"

# Sync (pyproject.toml updated, README preserved)
sync-env-to-collection ~/comfygit-examples -m "feat: add new node to txt2img"

cd ~/comfygit-examples
git push origin main

Repository Structure

After creating several examples:

comfygit-examples/
├── README.md                      # Main index
├── txt2img/
│   ├── README.md                  # Example docs (you write this)
│   ├── pyproject.toml             # Synced from .cec
│   ├── .python-version            # Synced from .cec
│   ├── .gitignore                 # Synced from .cec
│   ├── uv.lock                    # Synced from .cec
│   └── workflows/                 # Synced from .cec
│       ├── basic.json
│       └── advanced.json
├── img2img/
│   ├── README.md
│   ├── pyproject.toml
│   └── workflows/
└── video-gen/
    ├── README.md
    ├── pyproject.toml
    └── workflows/

Daily Workflow Summary

# Morning: Start working on example
comfygit activate txt2img
comfyui  # Develop workflows

# Throughout day: Make commits
comfygit commit -m "wip: testing new approach"
comfygit commit -m "feat: add advanced workflow"

# End of day: Publish when ready
sync-env-to-collection ~/comfygit-examples -m "feat: add advanced workflow"
cd ~/comfygit-examples
git push origin main

Tips

Commit often in ComfyGit - Your local .cec history is separate from examples repo
README is sacred - Script never overwrites your documentation
Preview first - Run sync without -m to see what changes before committing
Keep examples focused - One environment = one clear use case
Document workflows - Explain what each workflow does in README
Test imports - Occasionally import your own examples to verify they work

What Users See

When users import your example:

comfygit import \
  https://github.com/yourusername/comfygit-examples#txt2img \
  -n my-txt2img

They get:

✅ ComfyUI installed
✅ All nodes from pyproject.toml
✅ Python environment set up
✅ Workflows ready to use
✅ Models auto-resolved (if sources in pyproject.toml)

They DON'T get:

❌ Your local .cec/.git history
❌ Your development commits
❌ Models (unless configured in pyproject.toml)

Fresh, clean environment ready to use!

FilesExpand file tree

scripts

Directory actions

More options