Skip to content

docs: Update installation docs and clarify ComfyStream as a custom node #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update installation docs and clarify ComfyStream as a custom node #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions technical/get-started/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ icon: "download"

ComfyStream is available as a custom node through the [ComfyUI Manager](https://registry.comfy.org/nodes/comfystream) or as a Docker image. Follow the method that best suits your setup.

<Tip>
You can also install Comfystream by cloning the repository into your ComfyUI/custom_nodes folder — see [Manual Installation](/technical/get-started/install#manual-installation-cloning-repository) for details.
</Tip>

<CardGroup cols={2}>
<Card
title="ComfyUI Manager (Recommended)"
Expand Down Expand Up @@ -55,8 +59,8 @@ If you already have ComfyUI installed, the easiest way to install ComfyStream is

{/* <!-- prettier-ignore-start --> */}

<Accordion title="Manual Installation (Alternative)">
If you prefer to install ComfyStream manually instead of using the Manager, follow these steps:
<Accordion title="Manual Installation (Cloning Repository)">
If you prefer to install ComfyStream manually by cloning the repository instead of using the Manager, follow these steps:
```bash
cd /path/to/ComfyUI/custom_nodes/
git clone https://github.com/livepeer/comfystream.git
Expand Down
2 changes: 1 addition & 1 deletion technical/get-started/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ icon: "rocket"

## Overview

The **ComfyStream toolkit** adds powerful real-time video and audio capabilities to [ComfyUI](https://www.comfy.org/), making it easy to build interactive, AI-powered media workflows. It extends ComfyUI with specialized tools for streaming, live processing, and on-the-fly workflow updates, including:
**ComfyStream is a custom node** that adds powerful real-time video and audio capabilities to [ComfyUI](https://www.comfy.org/), making it easy to build interactive, AI-powered media workflows. It extends ComfyUI with specialized tools for streaming, live processing, and on-the-fly workflow updates, including:

- **[ComfyStream](https://github.com/livepeer/comfystream)** – A custom node that streams audio and video from your webcam and microphone into ComfyUI for real-time AI processing, then returns the processed output.
- **[ComfyUI-Stream-Pack](https://github.com/livepeer/ComfyUI-Stream-Pack)** – A collection of custom nodes designed to support advanced real-time audio and video workflows.
Expand Down