Skip to main content

​
Using nodes in Scope

The Scope node system enables third-party extensions to provide custom pipelines. Install nodes to access additional models, preprocessors, and capabilities beyond the built-in pipelines.

​
Node Sources

Nodes can be installed from three sources:
SourceFormatDescription
Git (Recommended)https://github.com/user/repoInstall directly from a Git repository
PyPImy-scope-nodeInstall from the Python Package Index
Local/path/to/nodeInstall from a local directory (development)

​
Git Installation

You can paste the URL directly from your browser: 
https://github.com/user/node-repo
Optionally specify a branch, tag, or commit: 
https://github.com/user/node-repo@v1.0.0
https://github.com/user/node-repo@main
https://github.com/user/node-repo@abc1234

​
PyPI Installation

my-scope-node
my-scope-node==1.0.0

​
Local Installation

/path/to/my-node
C:\Users\username\projects\my-node
Local nodes are installed in editable mode, meaning code changes take effect after reloading the node.

​
Installing Nodes

1

Open Node Settings

Click the gear icon in the app header to open the Settings dialog.Settings gear buttonNavigate to the Nodes tab.Nodes tab
2

Enter package spec

In the installation input field, enter the node source (Git URL, PyPI package name, or local path).You can also click Browse to select a local node directory.Install button
3

Install

Click the Install button and wait for installation to complete.Install progressThe server will restart automatically to load the new node.
4

Verify installation

The node should appear in the installed nodes list, and its pipelines will be available in the pipeline selector.

​
Managing Nodes

​
Viewing Installed Nodes

The Nodes tab in Settings displays all installed nodes with their source information.

​
Uninstalling a Node

1

Find the node

In the Nodes tab, locate the node you want to remove.
2

Uninstall

Click the trash icon next to the node.Uninstall button
3

Wait for restart

The server will restart to unload the node.

​
Updating a Node

Scope automatically checks for updates when you open the Nodes tab.
1

Open the Nodes tab

Any node with a newer version available shows an Update button.
2

Update

Click the Update button next to the node.
3

Wait for restart

The server will restart to load the updated node.
Local nodes do not support update detection. To pick up code changes for a local node, use Reload instead.

​
Reloading a Node (Local Only)

When developing a local node, you can reload it after making code changes without reinstalling:
1

Make your code changes

Edit the node source files.
2

Reload

Click the reload icon next to your locally installed node.Reload button
3

Wait for restart

The server will restart to pick up the changes.
The reload button only appears for nodes installed from local paths.
External sources can facilitate node installation via protocol URLs: 
daydream-scope://install-node?package=<spec>
When you click a deep link:
  1. The desktop app opens (or launches if not running)
  2. The Settings dialog opens with the Nodes tab selected
  3. The package spec is pre-filled in the input field
  4. You confirm to begin installation
Deep links are only supported in the Desktop App, not manual installations.

​
CLI Commands

The daydream-scope CLI provides commands for managing nodes directly from the terminal.

​
Listing Installed Nodes

uv run daydream-scope nodes
Shows all installed nodes with their name, version, source, and registered pipelines.

​
Installing a Node

uv run daydream-scope install <package>
Examples for each source type: 
# From a Git repository
uv run daydream-scope install https://github.com/user/node-repo

# From PyPI
uv run daydream-scope install my-scope-node

# From a local directory (editable mode)
uv run daydream-scope install -e /path/to/my-node
OptionDescription
--upgradeUpgrade the node to the latest version
-e, --editableInstall a project in editable mode from a local path

​
Uninstalling a Node

uv run daydream-scope uninstall <name>
Removes the node and unloads any active pipelines it provided.

​
Troubleshooting

  • Check that the package spec is correct (valid Git URL or PyPI package name)
  • Verify your internet connection
  • Check for dependency conflicts in the installation error message
  • Ensure the server restarted after installation
  • Check that the node implements the register_pipelines hook correctly
  • Verify the node’s pipelines meet your GPU’s VRAM requirements
  • The node may have introduced a dependency conflict
  • Try uninstalling the node via the Settings dialog
  • If that fails, manually remove the node from ~/.daydream-scope/nodes/nodes.txt

​
See Also

Developing Nodes

Create your own custom pipelines

Node Architecture

Technical details of the node system

Tutorial: Build a VFX Node

Step-by-step tutorial building a complete node from scratch