安裝
快速安裝程式會自動設定好 git、uv 與 Python（透過 uv）。前端 bundle 會從 GitHub 最新 release 直接下載預編好的版本，後端則會 checkout 到同一個 release tag，讓兩者保持同步 —— 一般使用者不需要 Node.js 或 pnpm。
:::tip 我該用哪種安裝方式？
- 快速安裝（本頁）—— 你只想執行 CodefyUI。
- 開發者安裝 —— 你想編輯程式碼或貢獻（手動設定
uv+ pnpm，並支援熱重載）。 :::
快速安裝
# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/treeleaves30760/CodefyUI/main/install.sh | bash
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/treeleaves30760/CodefyUI/main/install.ps1 | iex"
預設安裝到 ~/CodefyUI（macOS/Linux）或 %USERPROFILE%\CodefyUI（Windows）。可用環境變數 CODEFYUI_DIR 覆寫。
在 Windows 上，install.ps1 會透過 winget 安裝缺少的 git。winget 內建於 Windows 11 與較新的 Windows 10（透過「App Installer」套件）。
安裝程式會把 cdui 啟動器放到 ~/.local/bin/cdui（Windows 為 %USERPROFILE%\.local\bin\cdui.cmd）。請重新開啟你的 terminal，然後在任何目錄執行：
cdui start
開啟 http://localhost:8000。單一 uvicorn 程序會同時提供 API 與預編好的 React 前端。cdui start 預設在背景執行 —— 你可以關閉 terminal 而伺服器會繼續運作；用 cdui status 與 cdui stop 來管理它。加上 --foreground（-f）可改為前景執行，並以 Ctrl+C 停止。
本快速開始假設使用預設的 PyTorch 版本，它適用於所有平台（CPU / Apple Silicon MPS）。若需特定的 NVIDIA CUDA 版本、AMD ROCm，或想驗證 GPU 偵測，請參考 GPU 與裝置設定。
安裝旗標與環境變數
install.sh／install.ps1 與（首次安裝後的）cdui install 都接受同一組選項，可以用 CLI 旗標或預先設好的環境變數。stdin 是 TTY 時預設互動，否則走安全預設值。
| 旗標 | 環境變數 | 值 | 用途 |
|---|---|---|---|
--gpu <choice> | CODEFYUI_GPU | auto / cu118 / cu121 / cu124 / cu128 / rocm6.1 / rocm6.2 / cpu / mps / skip | 選擇 PyTorch wheel index。auto 透過 nvidia-smi／rocm-smi／Apple Silicon 自動偵測。skip 完全不裝 torch（進階）。 |
--dev / --no-dev | CODEFYUI_DEV | 1 / 0 | 是否安裝 [dev] extra（pytest、httpx、httpx-ws）。cdui test 需要。一般使用者預設關閉，貢獻者開啟。 |
--yes | — | — | 全部用預設值，不互動（CI／headless）。 |
--lang <code> | CODEFYUI_LANG | en / zh-TW | 安裝程式提示文字語言。 |
| — | CODEFYUI_DIR | path | 安裝目錄（預設 ~/CodefyUI）。 |
| — | CODEFYUI_RELEASE_TAG | tag | 鎖定前端 bundle 為某個 release（預設 latest）。 |
| — | CODEFYUI_FORCE_BUILD | 1 | 跳過下載 prebuilt dist，改在本地用 pnpm build（追蹤 main）。 |
正式模式與開發者模式
cdui start—— 單一 uvicorn 跑:8000提供預編前端。不需要 Node。 這是一般使用者的預設模式。cdui dev—— Vite dev server 跑:5173（HMR）+ uvicorn 跑:8000。需要 Node 24+ 與 pnpm。 編輯前端程式碼時使用 —— 請參考開發者安裝。cdui build—— 在本地重建frontend/dist（也需要 Node + pnpm）。
完整的啟動器指令清單請見 CLI 指令。
驗證是否正常運作
curl http://127.0.0.1:8000/api/health
這應該會回傳類似 {"status":"ok","nodes_loaded":94,"presets_loaded":3} 的內容（nodes_loaded 數量會隨每個版本增加 —— 確認非 0 即可）。
接著開啟前端，載入 Train CNN on MNIST 範例並點擊 執行。你應該會在下方面板看到訓練進度出現。
更新
cdui update
更新到最新 release（prebuilt 路徑），或拉取 main（從原始碼建置時）並重新同步前端。