Pluribus Docs
Getting started

Install the plugin

Prepare a clean ComfyUI installation and a private writable data directory for Pluribus.

Start from a clean plugin directory so demo data, old tokens, and private bindings from another run cannot affect the result.

Before you start

Have the real production context ready before opening the panel:

  • ComfyUI running Python 3.10 or newer
  • The character-sheet, storyboard, production, or final workflow you are already building
  • A real project name, client, and short non-confidential production description
  • The names and project roles of every represented person
  • A direct or representative contact for each confirmation request
  • Deliverables, channels, territory, dates, category, restrictions, compensation and exclusivity treatment, and final-approval expectations

For an internal rehearsal, use fictional people and contact details you control. Do not use a famous person, private biometric material, or confidential client assets merely to make the walkthrough realistic.

Clone the plugin

Use the current published installation instructions from the ComfyUI plugin repository. During controlled release-candidate testing, pin the exact candidate described in the release notes instead of assuming the default branch is a stable release.

Terminal
cd /path/to/ComfyUI/custom_nodes
git clone https://github.com/trypluribus/comfyui-pluribus

Then:

  1. Restart ComfyUI.
  2. Open Pluribus in the sidebar.
  3. Confirm the panel contains no demo people, projects, or permission records.

Use a private writable data directory

If the plugin directory is read-only, set a private writable data directory before starting ComfyUI:

Optional private data directory
export PLURIBUS_DATA_DIR="$HOME/.local/share/comfyui-pluribus"

Use that directory with only one ComfyUI process at a time. It stores the device credential and the private mapping between local workflow/source keys and opaque Pluribus references. Protect it as application state; do not commit it to a project repository.

Next step

You can find sources locally before pairing. Connect a workspace only when you are ready to create canonical project records and send confirmation requests.

On this page