diff --git a/basic-concepts/custom-nodes.mdx b/basic-concepts/custom-nodes.mdx index 66cf54647..595b5ab24 100644 --- a/basic-concepts/custom-nodes.mdx +++ b/basic-concepts/custom-nodes.mdx @@ -4,15 +4,15 @@ description: "Custom nodes in ComfyUI: how they differ from Comfy Core nodes, pl icon: "window-maximize" --- -## About Custom Nodes +## When do you need custom nodes? -After installing ComfyUI, you'll discover that it includes many built-in nodes. These native nodes are called **Comfy Core** nodes, which are officially maintained by ComfyUI. +ComfyUI already includes built-in nodes. A **custom node** is an extra node supplied by a community package. You only need to install one when a workflow requires it or when you want a feature it provides. A missing-model warning is different: it asks for a model file, not a custom node. Use [Fix a workflow that will not run](/get_started/fix-a-workflow) to tell the warnings apart. -Additionally, there are numerous [**custom nodes**](https://registry.comfy.org) created by various authors from the ComfyUI community. These custom nodes bring extensive functionality to ComfyUI, greatly expanding its capabilities and feature boundaries. +Find community packages in the [Comfy Registry](https://registry.comfy.org). If a package appears in an imported workflow, [ComfyUI Manager](/manager/overview) can help install and manage it. -In this guide, we'll cover various operations related to custom nodes, including installation, updates, disabling, uninstalling, and dependency installation. +The rest of this page covers installation, updates, disabling, uninstalling, and software dependencies. -Anyone can develop their own custom extensions for ComfyUI and share them with others. You can find many community custom nodes [here](https://registry.comfy.org). If you want to develop your own custom nodes, visit the section below to get started: +If you want to develop a custom node, start with the developer guide: Learn how to start developing a custom node @@ -336,4 +336,3 @@ If you have some development capabilities, please start with the documentation b Learn how to start developing a custom node - diff --git a/basic-concepts/dependencies.mdx b/basic-concepts/dependencies.mdx index 5189fdb1e..465796f61 100644 --- a/basic-concepts/dependencies.mdx +++ b/basic-concepts/dependencies.mdx @@ -1,6 +1,6 @@ --- title: "Dependencies" -description: "Understand dependencies in ComfyUI" +description: "Understand the files and software a shared ComfyUI workflow needs, with advanced Python troubleshooting." icon: "file" --- @@ -8,17 +8,16 @@ icon: "file" description: "Understand asset and software dependencies in ComfyUI" */} -## A workflow file depends on other files +## What a shared workflow may need -We often obtain various workflow files from the community, but frequently find that the workflow cannot run directly after loading. This is because a workflow file depends on other files besides the workflow itself, such as media asset inputs, models, custom nodes, related Python dependencies, etc. -ComfyUI workflows can only run normally when all relevant dependencies are satisfied. +A workflow file stores connected steps and settings. It does not include every file or extra node used by its creator. If a shared workflow will not run, check for these requirements first: -ComfyUI workflow dependencies mainly fall into the following categories: +- **Input files**: Images, video, or audio the workflow expects you to provide. +- **Local models**: Model files that must be downloaded and selected. +- **Custom nodes**: Extra node packages that are not installed in your ComfyUI. +- **Account and credits**: Requirements for hosted Partner Nodes or Comfy Cloud nodes. -- Assets (media files including audio, video, images, and other inputs) -- Custom nodes -- Python dependencies -- Models (such as Stable Diffusion models, etc.) +Start with [Fix a workflow that will not run](/get_started/fix-a-workflow) to identify the warning. The rest of this page explains these requirements and the Python packages needed by custom nodes. Most users do not need to manage Python packages directly. ## Assets @@ -145,4 +144,4 @@ This allows multiple ComfyUI instances to share the same model library, reducing An advanced application like ComfyUI also has **_software dependencies_**. These are libraries of programming code and data that are required for the application to run. Custom nodes are examples of software dependencies. On an even more fundamental level, the Python programming environment is the ultimate dependency for ComfyUI. The correct version of Python is required to run a particular version of ComfyUI. Updates to Python, ComfyUI, and custom nodes can all be handled from the **ComfyUI Manager** window. -![ComfyUI Custom Nodes Manager](/images/concepts/core-concepts_dependecies_custom-nodes-manager.png) \ No newline at end of file +![ComfyUI Custom Nodes Manager](/images/concepts/core-concepts_dependecies_custom-nodes-manager.png) diff --git a/basic-concepts/links.mdx b/basic-concepts/links.mdx index c86914d50..6e8e4e0bc 100644 --- a/basic-concepts/links.mdx +++ b/basic-concepts/links.mdx @@ -6,7 +6,9 @@ icon: "share-nodes" ## Links connect nodes -In ComfyUI, the lines or curves drawn between nodes are called **_links_** (also referred to as **_connections_** or wires). They carry data from one node's output to another node's input, defining the flow of your workflow. +The lines between nodes are **links**, also called connections. They carry the output of one step into the input of another. Follow them to see how a prompt, model, or image reaches the final output. For a first tour of the canvas, see [How ComfyUI works](/get_started/how-comfyui-works). + +The sections below explain display styles, reroutes, and connection types in more detail. Links can be displayed in several visual styles: curves, right angles, straight lines, or hidden entirely. diff --git a/basic-concepts/models.mdx b/basic-concepts/models.mdx index e4da68407..3e4c19de6 100644 --- a/basic-concepts/models.mdx +++ b/basic-concepts/models.mdx @@ -8,7 +8,11 @@ import ExternalModels from "/snippets/install/add-external-models.mdx" ## Models in plain terms -In ComfyUI, **models** are the weight files that actually run your workflow. They include **checkpoints**, **VAEs**, **LoRAs**, **ControlNets**, and upscalers. The app install is small. These files are **not** included by default. You usually **download them from the web**, place them under `ComfyUI/models/` (or follow a template’s prompts), then choose the file in the right **loader node** (on the canvas, these often appear as nodes whose names start with **Load**). +A **local model** is a file ComfyUI loads to generate or transform content on your device. A template can tell you which files it needs, but the workflow itself does not contain those large files. If ComfyUI shows a missing-model prompt, follow its file name and folder instructions. See [Fix a workflow that will not run](/get_started/fix-a-workflow) if you are unsure what is missing. + +Not every workflow uses a local model. **Partner Nodes** call hosted models and use credits instead of a model download. [Compare where workflows run](/get_started/where-work-runs). + +Local model files include checkpoints, VAEs, LoRAs, ControlNets, and upscalers. You usually place them under `ComfyUI/models/` (or follow a template's prompt), then choose each file in the matching loader node. The sections below cover model compatibility and manual setup in more detail. ### Supported models in ComfyUI diff --git a/basic-concepts/nodes.mdx b/basic-concepts/nodes.mdx index 0c687b932..7b62f1a47 100644 --- a/basic-concepts/nodes.mdx +++ b/basic-concepts/nodes.mdx @@ -1,15 +1,18 @@ --- title: "Nodes" -description: "Nodes are ComfyUI's fundamental building blocks: independent Comfy Core or custom modules you connect with links to assemble complex workflows." +description: "Learn what ComfyUI nodes do, how to read their inputs and outputs, and what common node states mean." icon: "circle" --- -In ComfyUI, nodes are the fundamental building blocks for executing tasks. Each node is an independently built module, whether it's a **Comfy Core** node or a **Custom Node**, with its own unique functionality. Nodes connect to each other through links, allowing us to build complex functionality like assembling LEGO blocks. -The combinations of different nodes create the unlimited possibilities of ComfyUI. +A **node** is a box that performs one step in a workflow. One node might load a model, another might read your text prompt, and another might save the finished image. Connect nodes to pass results between those steps. + +Start with a [workflow template](/interface/features/template) to see nodes working together. You can run a template before learning how to add or connect nodes yourself. + +For a short explanation of how nodes fit into a complete workflow, read [How ComfyUI works](/get_started/how-comfyui-works). The sections below cover node states, connections, controls, and menus in more detail. ![Comfy Core K-Sampler Node](/images/comfy_core/sampling/k_sampler.png) -For example, in the K-Sampler node, you can see it has multiple inputs and outputs, and also includes multiple parameter settings. These parameters determine the logic of node execution. Behind each node is well-written Python logic, allowing you to achieve corresponding functionality without having to write code yourself. +In the KSampler example, connections on the left provide inputs, settings inside the box control generation, and the connection on the right passes its result onward. You can change settings without writing code. ComfyUI is under active development, so some details here may be outdated. If you spot something that's changed, feel free to [help us update the docs](https://github.com/Comfy-Org/docs). @@ -17,9 +20,7 @@ ComfyUI is under active development, so some details here may be outdated. If yo ## Nodes perform operations -In computer science, a **_node_** is a container for information, usually including programmed instructions to perform some task. Nodes almost never exist in isolation, they're almost always connected to other nodes in a networked graph. In ComfyUI, nodes take the visual form of boxes that are connected to each other. - -ComfyUI nodes are usually **_function operators_**. This means that they operate on some data to perform a function. A function is a process that accepts input data, performs some operation on it, and produces output data. In other words, nodes do some work, contributing to the completion of a task such as generating an image. So ComfyUI nodes almost always have at least one input or output, and usually have multiple inputs and outputs. +Most nodes accept input, do a job, and produce output. A **Load Checkpoint** node, for example, loads a model that other nodes can use. A **Save Image** node receives the final image and saves it. The connecting lines are called [links](/basic-concepts/links). ## Different Node States diff --git a/basic-concepts/properties.mdx b/basic-concepts/properties.mdx index b70a12a2d..9d4c54589 100644 --- a/basic-concepts/properties.mdx +++ b/basic-concepts/properties.mdx @@ -1,19 +1,22 @@ --- -title: "Properties" -description: "Master Comfy properties with our official development documentation. Understand core concepts to build custom nodes efficiently. Read the full guide now." -icon: "circle" +title: "Node settings and inputs" +description: "Learn which values you can change inside a ComfyUI node and when a value comes from another node." +sidebarTitle: "Node settings and inputs" +icon: "sliders" --- -## Nodes are containers for properties +A node has controls you can change, such as a prompt, image size, or number of generation steps. These values are often called **settings**, **parameters**, or **properties**. You do not need to learn those names before running a [template](/interface/features/template). -Nodes usually have **_properties_**. Also known as **_parameters_** or **_attributes_**, node properties are variables that can be changed. Some properties can be adjusted manually by the user, using a data entry field called a **_widget_**. Other properties can be driven automatically by other nodes connected to the property **_input slot_** or port. Usually, a property can be converted from widget to input and vice versa, allowing users to control property values manually or automatically. +![Node settings](/images/concepts/core-concepts_properties.png) -Properties can take many forms and hold many different types of information. For example, a **Load Checkpoint** node has a single property:  the file path to the generative model checkpoint file. A **KSampler** node has multiple properties such as the number of sampling **steps**, **CFG** scale, **sampler\_name**, etc. +## Change a setting inside a node -![node properties](/images/concepts/core-concepts_properties.png) +Find the field in the node, enter a value, and run the workflow again. For example, a text input holds your prompt. A **Load Checkpoint** node has a selector for a local model file. A **KSampler** node has settings such as steps and sampling method. -## Data types +## When a value comes from another node -Information can come in many different forms, called **_data types_**. For example, alphanumeric text is known as a **_string_**, a whole number is an **_integer_**, and a number with a decimal point is known as a **_floating point_** number or **_float_**. New data types are always being added to ComfyUI. +Some controls can instead receive their value through a connection. In that case, follow the line to the node that supplies the input and change it there. The connection points are often called **ports** or **slots**. See [Links](/basic-concepts/links) for how connections work. -ComfyUI is written in the Python scripting language, which is very forgiving about data types. By contrast, the ComfyUI environment is very **_strongly typed_**. This means that different data types can’t be mixed up. For example, we can’t connect an image output to an integer input. This is a huge benefit to users, guiding them to proper workflow construction and preventing program errors. +Connections accept specific kinds of data. An image output, for example, cannot feed a number input. If two ports will not connect, check their input and output labels and types. + +For a simpler introduction to the whole canvas, start with [How ComfyUI works](/get_started/how-comfyui-works). diff --git a/basic-concepts/workflow.mdx b/basic-concepts/workflow.mdx index d2b4cb8f4..5b199e871 100644 --- a/basic-concepts/workflow.mdx +++ b/basic-concepts/workflow.mdx @@ -8,6 +8,8 @@ icon: "diagram-project" A workflow is a set of steps that tells ComfyUI how to create something. +If you are new to the canvas, start with [How ComfyUI works](/get_started/how-comfyui-works). This page is a more detailed reference for reading, running, saving, and sharing workflows. + You can think of a workflow like a recipe: - The recipe is the workflow. @@ -76,7 +78,7 @@ If a node is missing, has an error, or does not receive the data it needs, Comfy To get started, open a built-in workflow template from **Workflow** → **Browse Workflow Templates**. Templates provide complete examples that you can run and edit. -Templates use Core nodes included with ComfyUI. They also prompt you to download any required models. +Some templates use only nodes included with ComfyUI. Others come from custom nodes and may require extra installation. ComfyUI also prompts you when a template needs model files you do not have. The community has created many custom nodes that add more capabilities. Learn more in [Custom Nodes](/basic-concepts/custom-nodes). diff --git a/docs.json b/docs.json index 07acbbfd9..14e3f3d23 100644 --- a/docs.json +++ b/docs.json @@ -28,6 +28,12 @@ "group": "Get Started", "pages": [ "index", + "get_started/start_here", + "get_started/first_generation", + "get_started/how-comfyui-works", + "get_started/where-work-runs", + "get_started/fix-a-workflow", + "get_started/cloud", { "group": "Local (Self-Hosted)", "icon": "download", @@ -64,7 +70,6 @@ "installation/update_comfyui" ] }, - "get_started/cloud", { "group": "Install Custom Nodes", "icon": "puzzle-piece", @@ -87,8 +92,7 @@ ] } ] - }, - "get_started/first_generation" + } ] }, { @@ -103,14 +107,14 @@ ] }, { - "group": "Basic Concepts", + "group": "ComfyUI Reference", "pages": [ "basic-concepts/workflow", "basic-concepts/nodes", - "basic-concepts/custom-nodes", - "basic-concepts/properties", - "basic-concepts/links", "basic-concepts/models", + "basic-concepts/links", + "basic-concepts/properties", + "basic-concepts/custom-nodes", "basic-concepts/dependencies" ] }, diff --git a/get_started/cloud.mdx b/get_started/cloud.mdx index 6c7b3230b..8f02bb065 100644 --- a/get_started/cloud.mdx +++ b/get_started/cloud.mdx @@ -9,9 +9,13 @@ icon: "cloud" Click here to access ComfyUI Cloud directly + +Comfy Cloud is the full ComfyUI app in your browser. A **Comfy Cloud node** is one step in a workflow that uses Comfy's hosted GPUs. They are different ways to use cloud compute. See [Where a workflow runs](/get_started/where-work-runs). + + ## What is Comfy Cloud? -ComfyUI Cloud is the cloud version of ComfyUI with the same features as the local version. Everything is pre-installed and ready to use. +Comfy Cloud lets you use ComfyUI in a browser without installing the app on your computer. Choose a supported template to start. Available models and custom nodes can differ from a local installation. ### Key features diff --git a/get_started/first_generation.mdx b/get_started/first_generation.mdx index beeaa111e..d16ec49e0 100644 --- a/get_started/first_generation.mdx +++ b/get_started/first_generation.mdx @@ -1,173 +1,58 @@ --- -title: "Getting Started with AI Image Generation" -description: "Generate your first AI image with ComfyUI. Learn to load example workflows, install models, and complete your first text-to-image generation." -sidebarTitle: "First Generation" +title: "Create your first image" +description: "Run an image workflow in ComfyUI, change its prompt, and save the result." +sidebarTitle: "Create your first image" icon: "shoe-prints" --- -import InstallLink from "/snippets/install/install-link.mdx" -import FindModelsFolder from "/snippets/install/find-models-folder.mdx" +A **workflow** is a set of connected steps that creates an image, video, or other result. You can start with a ready-made template. You do not need to build a workflow or understand every node before your first run. - -This guide is intended for **local users** running ComfyUI on their own device. If you'd prefer not to install anything locally, try our official cloud service instead. - - - - Run ComfyUI online with zero setup. Sign in with Google to get **400 free credits every month**. - - -This guide aims to help you understand ComfyUI's basic operations and complete your first image generation. We'll cover: - -1. Loading example workflows - - Loading from ComfyUI's workflow templates - - Loading from images with workflow metadata -2. Model installation guidance - - Automatic model installation - - Manual model installation -3. Completing your first text-to-image generation - -## About Text-to-Image - -Text-to-Image is a fundamental AI drawing feature that generates images from text descriptions. It's one of the most commonly used functions in AI art generation. You can think of the process as telling your requirements (positive and negative prompts) to an artist (the drawing model), who will then create what you want. Detailed explanations about text-to-image will be covered in the [Text to Image](/tutorials/basic/text-to-image) chapter. - -## ComfyUI Text-to-Image Workflow Tutorial - -### 1. Launch ComfyUI - -Make sure you've followed the [installation guide](/installation/system_requirements) to start ComfyUI and can successfully enter the ComfyUI interface. Alternatively, you can use [Comfy Cloud](/get_started/cloud) to use ComfyUI without any installation. - -![ComfyUI Interface](/images/desktop/comfyui-interface.jpg) - -If you have not installed ComfyUI, please choose a suitable version to install based on your device. - - - -### 2. Load Default Text-to-Image Workflow - -ComfyUI usually loads the default text-to-image workflow automatically when launched. However, you can try different methods to load workflows to familiarize yourself with ComfyUI's basic operations: - - - {/* - ![ComfyUI Interface](/images/tutorial/gettingstarted/sidebar_template.png) - Follow the numbered steps in the image: - 1. Click the **Fit View** button in the bottom right to ensure any loaded workflow isn't hidden - 2. Click the **folder icon (workflows)** in the sidebar - 3. Click the **Browse example workflows** button at the top of the Workflows panel - - Continue with: - ![Load Workflow](/images/tutorial/gettingstarted/template_library_default_workflow.png) - - 4. Select the first default workflow **Image Generation** to load it - */} - - - All images generated by ComfyUI contain metadata including workflow information. You can load workflows by: - - Dragging and dropping a ComfyUI-generated image into the interface - - Using menu **Workflows** -> **Open** to open an image - - Try loading the workflow using this example image: - ![ComfyUI-Text to Image Workflow](https://raw.githubusercontent.com/Comfy-Org/example_workflows/refs/heads/main/text-to-image-workflow.png) - - - - - ComfyUI workflows can be stored in JSON format. You can export workflows using menu **Workflows** -> **Export**. +## Before you begin - Try downloading and loading this example workflow: - -

Download text-to-image.json

- +You can follow this guide in [Comfy Cloud](/get_started/cloud) first. Open it in your browser to use an image template without installing ComfyUI or downloading a local model. If you prefer to run ComfyUI on your own computer, [install Comfy Desktop](/installation/desktop/overview) and follow the same steps. A local template may ask you to download models. - After downloading, use menu **Workflows** -> **Open** to load the JSON file. - - - -### 3. Model Installation - -Most ComfyUI installations don't include base models by default. After loading the workflow, if you don't have the [v1-5-pruned-emaonly-fp16.safetensors](https://huggingface.co/Comfy-Org/stable-diffusion-v1-5-archive/blob/main/v1-5-pruned-emaonly-fp16.safetensors) model installed, you'll see this prompt: - -First, ComfyUI will warn you that some models are missing: - -![Missing models warning](/images/tutorial/gettingstarted/missing_model_warning_1.png) - -Click the warning to see which model is missing and the download link: - -![Missing model details](/images/tutorial/gettingstarted/missing_model_warning_2.png) - - - -You can install models through: - - - - After you click the **Download** button, ComfyUI will execute the download, and different behaviors will be performed depending on the version you are using. - - - - The desktop version will automatically complete the model download and save it to the `/ComfyUI/models/checkpoints` directory. - You can wait for the installation to complete or view the installation progress in the model panel on the sidebar. - - ![Model Download Progress](/images/tutorial/gettingstarted/desktop_download_status.png) - - - Automatic downloads typically fetch models from **Hugging Face**. Make sure your network can reliably reach Hugging Face. - - If the download **does not start** or shows **no progress for a long time**, copy the model link from the missing-model details (or use the manual installation section below) and install the model manually. - - - - - - The browser will execute file downloads. Please save the file to the `/ComfyUI_windows_portable/ComfyUI/models/checkpoints` directory after the download is complete. - - - - - - - Visit [v1-5-pruned-emaonly-fp16.safetensors](https://huggingface.co/Comfy-Org/stable-diffusion-v1-5-archive/blob/main/v1-5-pruned-emaonly-fp16.safetensors) and follow this guide: - - ![Hugging Face Model Download](/images/tutorial/gettingstarted/first-image-generation-5-hugging-face.jpg) - - Save the downloaded file to: - - - - Save to `/ComfyUI/models/checkpoints` + +This guide uses an image template as an example. Template names and available models can change as ComfyUI is updated. + - ![Comfy Desktop Model Save Location](/images/tutorial/gettingstarted/first-image-generation-6-2-desktop.jpg) - - - Save to `ComfyUI_windows_portable/ComfyUI/models/checkpoints` - - ![ComfyUI Portable Model Save Location](/images/tutorial/gettingstarted/first-image-generation-6-1-portable.jpg) - - +## Run an image template - Refresh or restart ComfyUI after saving. - - + + + In ComfyUI, click **Templates** in the left sidebar, or open **Workflow** → **Browse Workflow Templates**. Choose an image generation template that accepts a text prompt. -### 4. Load Model and Generate Your First Image + A template loads a complete workflow onto the canvas. Each box is a **node** that handles one part of the process. The lines between boxes pass information from one node to the next. + + + In Comfy Cloud, choose a template whose models are ready to use. On a local installation, ComfyUI may report missing models. Follow its download prompt before running the workflow. -After you install or update models, press **`R`** on your keyboard to refresh object definitions and update model lists in nodes (for example, the dropdown in **Load Checkpoint**). Then continue with the steps below: + Comfy Desktop downloads supported files from the prompt. With portable or manual installations, the browser may download the files instead. Save each file in the model folder shown in the prompt, then refresh the model list or restart ComfyUI. See [Workflow Templates](/interface/features/template#model-storage-location) for details. + + + Find the text input in the loaded workflow and replace it with a short description, such as `a red bicycle parked beside a café, watercolor illustration`. Depending on the template, this may be a text field inside a node or an input panel. -![Run workflow](/images/tutorial/gettingstarted/run_workflow.png) -1. In the **Load Checkpoint** node, ensure **v1-5-pruned-emaonly-fp16.safetensors** is selected -2. Click `Run` or press `Ctrl + Enter` to generate + Click **Run**. ComfyUI will process the workflow and show the result in its output node or the queue panel. The first run can take longer while the model loads. + + + Right-click the finished image and select **Save image**. Change a few words in the prompt and click **Run** again to see what changes. + + -The result will appear in the **Save Image** node. Right-click to save locally. +## What you just used -![ComfyUI First Image Generation Result](/images/tutorial/gettingstarted/result.png) +- **Template**: A ready-made workflow you can run and edit. +- **Node**: A box that performs a step, such as loading a model, reading a prompt, or saving an image. +- **Model**: The downloaded AI file used to generate the result. Local workflows need the models they reference. +- **Link**: A connection that passes information between nodes. -For detailed text-to-image instructions, see our comprehensive guide: +You can learn more in [Workflows](/basic-concepts/workflow), or follow the [text-to-image tutorial](/tutorials/basic/text-to-image) to explore the image generation steps in detail. - - Click here for detailed text-to-image workflow instructions - +If you are unsure whether your template uses a downloaded model or a hosted node, see [Where a workflow runs](/get_started/where-work-runs). -## Troubleshooting +## If the workflow does not run -### Model Loading Issues +- **Missing model**: Open the missing-model details and install the requested file. If a model dropdown is empty after downloading, check its folder and refresh or restart ComfyUI. +- **Missing node**: Try a built-in template first. Imported or custom-node templates may require extra nodes. See [install custom nodes](/installation/install_custom_node). +- **No visible result**: Check the queue panel for progress or errors, and look for an output node such as **Save Image**. -If the `Load Checkpoint` node shows no models or displays "null", verify your model installation location and try refreshing or restarting ComfyUI. +For other errors, use [Fix a workflow that will not run](/get_started/fix-a-workflow). diff --git a/get_started/fix-a-workflow.mdx b/get_started/fix-a-workflow.mdx new file mode 100644 index 000000000..2f4019f3b --- /dev/null +++ b/get_started/fix-a-workflow.mdx @@ -0,0 +1,20 @@ +--- +title: "Fix a workflow that will not run" +description: "Find the next step when a workflow is missing a model, node, input, account, or credits." +icon: "screwdriver-wrench" +--- + +When you load a template or a workflow shared by someone else, ComfyUI may need files, nodes, inputs, or account access that are not included in the workflow. Start with the first warning you see. + +| What you see | What it usually means | Next step | +| --- | --- | --- | +| **Missing model** or an empty model selector | A local model file is unavailable or in the wrong folder | Open the model details, download the requested file, place it in the indicated folder, then refresh or restart ComfyUI. See [model files](/basic-concepts/models). | +| **Missing node** | The workflow uses a node your installation does not have | Try a built-in template, or [install the required custom node](/installation/install_custom_node). Update ComfyUI if the missing node is part of a newer core release. | +| **Missing image, video, audio, or other input** | The workflow expects a file or prompt you have not provided | Find the input node or panel, provide the requested file or text, then run again. | +| **Sign-in, network, or credit error** | A Partner Node or Comfy Cloud node is calling a hosted service | Check your connection, sign in to your Comfy account, and check your credits. See [where workflows run](/get_started/where-work-runs). | + +## Check the workflow before installing anything + +A workflow file stores its steps and settings. It does not bundle every model, custom node, or input file used by its creator. Look at the missing-item warning and identify which category it belongs to. You do not need to install custom nodes to fix a missing model, and downloading a model will not fix an account or credit error. + +If a built-in template still fails after you satisfy its listed requirements, check [Workflow Templates](/interface/features/template) for model folder details or visit the [troubleshooting guide](/troubleshooting/overview). diff --git a/get_started/how-comfyui-works.mdx b/get_started/how-comfyui-works.mdx new file mode 100644 index 000000000..84411a9a0 --- /dev/null +++ b/get_started/how-comfyui-works.mdx @@ -0,0 +1,36 @@ +--- +title: "How ComfyUI works" +description: "Understand templates, workflows, nodes, models, and connections using your first image as an example." +icon: "diagram-project" +--- + +You do not need to build a graph from scratch to use ComfyUI. A template gives you a working starting point. The boxes on its canvas show the steps ComfyUI will take. + +![A simple ComfyUI workflow](/images/simple_workflow.jpg) + +## Read a workflow from input to result + +Imagine the image you made in [Create your first image](/get_started/first_generation): + +1. A text input describes what you want. +2. A model is selected or loaded to generate the image. +3. Generation steps use that input and model. +4. An output step shows or saves the finished image. + +The boxes are **nodes**. Each node does one job. The lines are **connections**, also called links, that pass results between nodes. You can follow the connections to see where an input goes. You usually edit a prompt or other setting inside a node, then click **Run** to execute the workflow again. + +## What is a template? + +A **workflow** is the complete set of nodes, settings, and connections. A **template** is a ready-made workflow you can load and edit. A template saves you from assembling the steps yourself, but it does not always include everything needed to run: + +- A workflow using a **local model** needs the corresponding model files on your device. +- A workflow using a **Partner Node** calls a hosted model and may need an account and credits. +- A workflow from another person may also need input images or community custom nodes. + +A template is therefore a starting point, not a separate way of running ComfyUI. [Compare local and hosted execution](/get_started/where-work-runs). + +## What should you change first? + +Change one prompt and run the workflow again. Once you can see how the result changes, try one more input, such as image size or an input image. You can leave the rest of the nodes connected as the template provides them. + +If a workflow cannot run, [use the symptom-based guide](/get_started/fix-a-workflow). For more detail, see the reference pages for [workflows](/basic-concepts/workflow), [nodes](/basic-concepts/nodes), [models](/basic-concepts/models), and [links](/basic-concepts/links). diff --git a/get_started/start_here.mdx b/get_started/start_here.mdx new file mode 100644 index 000000000..d4212d270 --- /dev/null +++ b/get_started/start_here.mdx @@ -0,0 +1,30 @@ +--- +title: "Start here" +description: "Choose where to run ComfyUI and follow a short path from your first template to understanding a workflow." +icon: "compass" +--- + +ComfyUI lets you create images, video, audio, and more by connecting steps on a canvas. A set of connected steps is called a **workflow**. You can begin with a ready-made **template** and change it later. + +## Choose where to run ComfyUI + + + + Open ComfyUI in a browser. No local installation or model download is needed to try a template. + + + Install Comfy Desktop on Windows, macOS, or Linux. Your device runs local models you download. + + + +Both paths use workflows and templates. If you use a **Partner Node** in either path, that node calls a hosted model and may require an account and credits. [Compare the ways a workflow can run](/get_started/where-work-runs). + +## Your first three steps + +1. [Create your first image](/get_started/first_generation) with a template. You can follow the Cloud path first, or use your local installation. +2. [Understand the workflow you used](/get_started/how-comfyui-works). Learn what a template, node, model, and connection do. +3. [Try another template](/interface/features/template) or follow a [text-to-image tutorial](/tutorials/basic/text-to-image) to change more than the prompt. + + +If you opened a workflow from someone else and it will not run, start with [Fix a workflow that will not run](/get_started/fix-a-workflow). It helps you identify missing models, missing nodes, inputs, and account or credit requirements. + diff --git a/get_started/where-work-runs.mdx b/get_started/where-work-runs.mdx new file mode 100644 index 000000000..7a4a0cc15 --- /dev/null +++ b/get_started/where-work-runs.mdx @@ -0,0 +1,33 @@ +--- +title: "Where a workflow runs" +description: "Compare local models, Partner Nodes, Comfy Cloud nodes, and the Comfy Cloud app." +icon: "location-dot" +--- + +A template is a ready-made workflow. It does not tell you by itself whether generation happens on your computer or on a hosted service. Look at the nodes and the model requirements in that workflow. + +| What you use | Where the generation runs | What you typically need | +| --- | --- | --- | +| Local model nodes | On your own device | Compatible hardware and model files downloaded to your device | +| API nodes (Partner Nodes) | On a partner's hosted service | Internet access, a Comfy account, and credits for paid calls | +| Comfy Cloud nodes | On Comfy's hosted GPUs | Internet access, a Comfy account, and credits | + +**Partner Nodes** and **Comfy Cloud nodes** can appear alongside local nodes in a workflow. A single workflow can use more than one execution method. + +## Local models + +A local model is a file you download and select in a loader node. ComfyUI uses your own hardware to run it. The file may be large, and the workflow cannot run until all required files are available in the expected folders. [Learn about model files](/basic-concepts/models). + +## Partner Nodes + +Partner Nodes call external hosted models from inside a ComfyUI workflow. You do not download that model's weights, but paid calls require credits and a Comfy account. The price depends on the node and its settings. Check the node's cost information and the [Partner Node pricing guide](/tutorials/partner-nodes/pricing) before you run it. [Learn how Partner Nodes work](/tutorials/partner-nodes/overview). + +## Comfy Cloud nodes and the Comfy Cloud app + +A **Comfy Cloud node** is a node in a workflow that runs a curated model on Comfy's GPUs. It uses credits and does not require you to download that model. See [Comfy Cloud nodes](/cloud-nodes/overview). + +The **Comfy Cloud app** is the entire ComfyUI interface hosted in your browser. You can open templates there without installing ComfyUI locally. It is different from adding a Comfy Cloud node to a workflow on your own computer. See [Comfy Cloud](/get_started/cloud). + +## If a template will not run + +Read the message ComfyUI shows. A **missing model** means a local file must be downloaded or selected. A **missing node** means the workflow needs an unavailable node. A sign-in or credit message usually comes from a hosted node. [Find the next step for each symptom](/get_started/fix-a-workflow). diff --git a/index.mdx b/index.mdx index 3fe2670a4..234f9a1df 100644 --- a/index.mdx +++ b/index.mdx @@ -51,40 +51,54 @@ mode: "frame"

-The most powerful open source node-based application for generative AI +Create images, video, audio, and more with connected, reusable workflows.

{/* Getting Started Section */}

Getting Started

+

New to ComfyUI? Start with a template, then learn what each part of the workflow does.

- Install ComfyUI on Windows, macOS, or Linux + Choose Cloud or local ComfyUI and follow the beginner path + Start in your browser without installing ComfyUI or downloading models + + - Create your first AI-generated image + Set up Comfy Desktop on Windows, macOS, or Linux - Understand workflows, nodes, and links + Open a template, change a prompt, and run it - Explore community workflows and templates from top creators + See how templates, nodes, models, and connections fit together + + + Understand downloads, hosted models, and credits + + + Find what to do when a model, node, input, or account is missing
diff --git a/tutorials/partner-nodes/overview.mdx b/tutorials/partner-nodes/overview.mdx index 3ed50bf05..737bfed80 100644 --- a/tutorials/partner-nodes/overview.mdx +++ b/tutorials/partner-nodes/overview.mdx @@ -7,7 +7,7 @@ sidebarTitle: "Overview" import Requirements from "/snippets/tutorials/partner-nodes/requirements.mdx"; import Faq from "/snippets/tutorials/partner-nodes/faq.mdx"; -Partner Nodes are ComfyUI's new way of calling closed-source models through API requests, providing ComfyUI users with access to external state-of-the-art AI models without complex API key setup. +API nodes (Partner Nodes) let a node in your workflow call a hosted model from a partner. You use that node like other ComfyUI nodes, but the model runs on an external service rather than on your own computer. Paid calls require a Comfy account and credits. For a beginner-friendly comparison with local models and Comfy Cloud nodes, see [Where a workflow runs](/get_started/where-work-runs). ## What are Partner Nodes?