comfyui_setup.sh 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. #!/usr/bin/env bash
  2. # ComfyUI Setup — Install, launch, and verify using the official comfy-cli.
  3. #
  4. # Improvements over v1:
  5. # - Prefers `pipx` / `uvx` over global `pip install` (avoids polluting system Python)
  6. # - Idempotent: detects already-running server and skips re-launch
  7. # - Configurable port via --port=N (default 8188)
  8. # - Configurable workspace via --workspace=PATH
  9. # - Persistent log file in $TMPDIR/comfyui_setup.<pid>.log (Hermes scratch dir) for debugging
  10. # - SIGINT trap cleans up partial state
  11. # - Refuses local install when hardware_check.py verdict is "cloud"
  12. # - Forwards extra flags to comfy-cli (e.g. --cuda-version=12.4)
  13. #
  14. # Usage:
  15. # bash scripts/comfyui_setup.sh
  16. # (auto-detects GPU; uses recommendation from hardware_check.py)
  17. # bash scripts/comfyui_setup.sh --nvidia
  18. # bash scripts/comfyui_setup.sh --m-series --port=8190
  19. # bash scripts/comfyui_setup.sh --amd --workspace=/data/comfy
  20. #
  21. # Flags:
  22. # --nvidia | --amd | --m-series | --cpu GPU selection (skips hw check)
  23. # --port=N HTTP port (default 8188)
  24. # --workspace=PATH ComfyUI install location
  25. # --skip-launch Install only, don't start server
  26. # --force-cloud-override Install locally even if hw says cloud
  27. # -- Pass remaining args to `comfy install`
  28. set -euo pipefail
  29. SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  30. HARDWARE_CHECK="$SCRIPT_DIR/hardware_check.py"
  31. LOG_DIR="${TMPDIR:-${HERMES_HOME:-$HOME/.hermes}/cache/scratch}"
  32. mkdir -p "$LOG_DIR"
  33. LOG_FILE="$LOG_DIR/comfyui_setup.$$.log"
  34. PORT=8188
  35. WORKSPACE=""
  36. GPU_FLAG=""
  37. SKIP_LAUNCH=0
  38. FORCE_CLOUD_OVERRIDE=0
  39. EXTRA_INSTALL_ARGS=()
  40. cleanup() {
  41. local exit_code=$?
  42. if [ $exit_code -ne 0 ]; then
  43. echo "==> Setup exited with status $exit_code. Log: $LOG_FILE" >&2
  44. fi
  45. exit $exit_code
  46. }
  47. trap cleanup EXIT INT TERM
  48. log() { echo "==> $*" | tee -a "$LOG_FILE" >&2; }
  49. err() { echo "ERROR: $*" | tee -a "$LOG_FILE" >&2; }
  50. # --- Argument parsing ---
  51. PASSTHROUGH=0
  52. for arg in "$@"; do
  53. if [ "$PASSTHROUGH" -eq 1 ]; then
  54. EXTRA_INSTALL_ARGS+=("$arg")
  55. continue
  56. fi
  57. case "$arg" in
  58. --nvidia|--amd|--m-series|--cpu)
  59. GPU_FLAG="$arg"
  60. ;;
  61. --port=*)
  62. PORT="${arg#*=}"
  63. ;;
  64. --workspace=*)
  65. WORKSPACE="${arg#*=}"
  66. ;;
  67. --skip-launch)
  68. SKIP_LAUNCH=1
  69. ;;
  70. --force-cloud-override)
  71. FORCE_CLOUD_OVERRIDE=1
  72. ;;
  73. --)
  74. PASSTHROUGH=1
  75. ;;
  76. --help|-h)
  77. # Print the leading comment block, stripping the `# ` prefix.
  78. # Stops at the first blank line which separates docs from code.
  79. awk '
  80. NR == 1 { next } # skip shebang
  81. /^[^#]/ { exit } # stop at first non-comment line
  82. /^$/ { exit } # ...or first blank line
  83. { sub(/^# ?/, ""); print }
  84. ' "$0"
  85. exit 0
  86. ;;
  87. *)
  88. err "Unknown argument: $arg"
  89. exit 64
  90. ;;
  91. esac
  92. done
  93. log "Logging to $LOG_FILE"
  94. # --- Step 0: Hardware check (skipped if user gave an explicit GPU flag) ---
  95. if [ -z "$GPU_FLAG" ]; then
  96. if [ ! -f "$HARDWARE_CHECK" ]; then
  97. log "hardware_check.py not found — defaulting to --nvidia"
  98. GPU_FLAG="--nvidia"
  99. else
  100. log "Running hardware check…"
  101. set +e
  102. HW_JSON="$(python3 "$HARDWARE_CHECK" --json 2>>"$LOG_FILE")"
  103. HW_EXIT=$?
  104. set -e
  105. if [ -z "$HW_JSON" ]; then
  106. err "hardware_check.py produced no output (exit $HW_EXIT). Pass an explicit flag."
  107. exit 1
  108. fi
  109. echo "$HW_JSON" | tee -a "$LOG_FILE" >&2
  110. VERDICT="$(echo "$HW_JSON" | python3 -c 'import sys,json; print(json.load(sys.stdin).get("verdict",""))')"
  111. FLAG="$(echo "$HW_JSON" | python3 -c 'import sys,json; print(json.load(sys.stdin).get("comfy_cli_flag") or "")')"
  112. if [ "$VERDICT" = "cloud" ] && [ "$FORCE_CLOUD_OVERRIDE" -ne 1 ]; then
  113. log ""
  114. log "Hardware check: this machine is not suitable for local ComfyUI."
  115. log "Recommended: Comfy Cloud — https://platform.comfy.org"
  116. log ""
  117. log "To override and force a local install, re-run with --force-cloud-override"
  118. log "or pass an explicit GPU flag (--nvidia|--amd|--m-series|--cpu)."
  119. exit 2
  120. fi
  121. if [ "$VERDICT" = "marginal" ]; then
  122. log "Hardware check: verdict is MARGINAL."
  123. log " SD1.5 should work; SDXL/Flux may be slow or OOM."
  124. log " Consider Comfy Cloud for heavier workflows: https://platform.comfy.org"
  125. fi
  126. if [ -z "$FLAG" ]; then
  127. log "hardware_check could not pick a comfy-cli flag. Defaulting to --nvidia."
  128. log "(For Intel Arc or unsupported hardware, use the manual install path.)"
  129. GPU_FLAG="--nvidia"
  130. else
  131. GPU_FLAG="$FLAG"
  132. fi
  133. fi
  134. fi
  135. log "GPU flag: $GPU_FLAG"
  136. log "Port: $PORT"
  137. [ -n "$WORKSPACE" ] && log "Workspace: $WORKSPACE"
  138. [ "${#EXTRA_INSTALL_ARGS[@]}" -gt 0 ] && log "Extra install args: ${EXTRA_INSTALL_ARGS[*]}"
  139. # --- Step 1: Install comfy-cli (prefer pipx / uvx over global pip) ---
  140. COMFY_BIN=""
  141. if command -v comfy >/dev/null 2>&1; then
  142. COMFY_BIN="comfy"
  143. log "comfy-cli already on PATH: $(comfy -v 2>/dev/null || echo 'unknown version')"
  144. elif command -v uvx >/dev/null 2>&1; then
  145. log "Using uvx (no install needed)"
  146. COMFY_BIN="uvx --from comfy-cli comfy"
  147. elif command -v pipx >/dev/null 2>&1; then
  148. log "Installing comfy-cli via pipx…"
  149. pipx install comfy-cli >>"$LOG_FILE" 2>&1
  150. COMFY_BIN="comfy"
  151. # pipx adds shims to ~/.local/bin which may need to be on PATH
  152. if ! command -v comfy >/dev/null 2>&1; then
  153. if [ -x "$HOME/.local/bin/comfy" ]; then
  154. export PATH="$HOME/.local/bin:$PATH"
  155. COMFY_BIN="$HOME/.local/bin/comfy"
  156. fi
  157. fi
  158. else
  159. log "Neither pipx nor uvx found. Falling back to pip install --user…"
  160. log " (Recommend installing pipx: https://pipx.pypa.io)"
  161. if ! pip install --user comfy-cli >>"$LOG_FILE" 2>&1; then
  162. # macOS: PEP 668 externally-managed-environment may block --user
  163. log "pip install --user failed. Retrying with --break-system-packages…"
  164. pip install --user --break-system-packages comfy-cli >>"$LOG_FILE" 2>&1 || {
  165. err "Could not install comfy-cli. Install pipx or uv first."
  166. exit 1
  167. }
  168. fi
  169. # Resolve the actual `comfy` script — pip --user puts it in:
  170. # Linux: ~/.local/bin/comfy
  171. # macOS: ~/Library/Python/<ver>/bin/comfy OR ~/.local/bin/comfy
  172. COMFY_BIN=""
  173. for candidate in "$HOME/.local/bin/comfy" \
  174. "$HOME/Library/Python/3.13/bin/comfy" \
  175. "$HOME/Library/Python/3.12/bin/comfy" \
  176. "$HOME/Library/Python/3.11/bin/comfy" \
  177. "$HOME/Library/Python/3.10/bin/comfy"; do
  178. if [ -x "$candidate" ]; then
  179. COMFY_BIN="$candidate"
  180. export PATH="$(dirname "$candidate"):$PATH"
  181. break
  182. fi
  183. done
  184. if [ -z "$COMFY_BIN" ]; then
  185. if command -v comfy >/dev/null 2>&1; then
  186. COMFY_BIN="comfy"
  187. else
  188. err "Installed comfy-cli but couldn't find the 'comfy' script."
  189. err "Add the right Python user-bin directory to PATH and retry."
  190. exit 1
  191. fi
  192. fi
  193. fi
  194. # --- Step 2: Disable analytics tracking (avoid interactive prompt) ---
  195. log "Disabling analytics tracking…"
  196. $COMFY_BIN --skip-prompt tracking disable >>"$LOG_FILE" 2>&1 || true
  197. # --- Step 3: Install ComfyUI ---
  198. WORKSPACE_ARG=()
  199. if [ -n "$WORKSPACE" ]; then
  200. WORKSPACE_ARG=(--workspace "$WORKSPACE")
  201. fi
  202. if $COMFY_BIN "${WORKSPACE_ARG[@]}" which 2>/dev/null | grep -q "ComfyUI"; then
  203. EXISTING_WS="$($COMFY_BIN "${WORKSPACE_ARG[@]}" which 2>/dev/null || true)"
  204. log "ComfyUI already installed at: $EXISTING_WS"
  205. else
  206. log "Installing ComfyUI ($GPU_FLAG)…"
  207. if ! $COMFY_BIN "${WORKSPACE_ARG[@]}" --skip-prompt install "$GPU_FLAG" "${EXTRA_INSTALL_ARGS[@]}" >>"$LOG_FILE" 2>&1; then
  208. err "Install failed. Tail of log:"
  209. tail -20 "$LOG_FILE" >&2
  210. exit 1
  211. fi
  212. fi
  213. if [ "$SKIP_LAUNCH" -eq 1 ]; then
  214. log "Setup complete (--skip-launch). Run \`$COMFY_BIN launch --background -- --port $PORT\` when ready."
  215. exit 0
  216. fi
  217. # --- Step 4: Detect already-running server ---
  218. if curl -fsS "http://127.0.0.1:$PORT/system_stats" >/dev/null 2>&1; then
  219. log "Server already running on port $PORT — skipping launch."
  220. log "Stop with \`$COMFY_BIN stop\` if you want a fresh start."
  221. curl -fsS "http://127.0.0.1:$PORT/system_stats" | python3 -m json.tool 2>/dev/null || true
  222. log "Done."
  223. exit 0
  224. fi
  225. # --- Step 5: Launch ---
  226. log "Launching ComfyUI in background on port $PORT…"
  227. LAUNCH_EXTRAS=("--" "--port" "$PORT")
  228. if ! $COMFY_BIN "${WORKSPACE_ARG[@]}" launch --background "${LAUNCH_EXTRAS[@]}" >>"$LOG_FILE" 2>&1; then
  229. err "Background launch failed. Tail of log:"
  230. tail -20 "$LOG_FILE" >&2
  231. err "Try foreground launch to see real-time errors: $COMFY_BIN launch -- --port $PORT"
  232. exit 1
  233. fi
  234. # --- Step 6: Wait for server ---
  235. log "Waiting for server…"
  236. MAX_WAIT=60
  237. ELAPSED=0
  238. while [ $ELAPSED -lt $MAX_WAIT ]; do
  239. if curl -fsS "http://127.0.0.1:$PORT/system_stats" >/dev/null 2>&1; then
  240. log "Server is running!"
  241. curl -fsS "http://127.0.0.1:$PORT/system_stats" | python3 -m json.tool 2>/dev/null || true
  242. break
  243. fi
  244. sleep 2
  245. ELAPSED=$((ELAPSED + 2))
  246. done
  247. if [ $ELAPSED -ge $MAX_WAIT ]; then
  248. err "Server did not start within ${MAX_WAIT}s."
  249. err "Inspect log: $LOG_FILE"
  250. err "Or run foreground: $COMFY_BIN launch -- --port $PORT"
  251. exit 1
  252. fi
  253. log ""
  254. log "Setup complete!"
  255. log " Server: http://127.0.0.1:$PORT"
  256. log " Web UI: http://127.0.0.1:$PORT (open in browser)"
  257. log " Stop: $COMFY_BIN stop"
  258. log " Log: $LOG_FILE (kept until shell closes)"
  259. log ""
  260. log "Next steps:"
  261. log " - Download a model: $COMFY_BIN model download --url <URL> --relative-path models/checkpoints"
  262. log " - Run a workflow: python3 $SCRIPT_DIR/run_workflow.py --workflow <file.json> --args '{...}'"
  263. # Disable trap on success path
  264. trap - EXIT