pyproject.toml
Node ID
The node id (“name” field in toml file) uniquely identifies the custom node, and will be used in URLs from the registry. Users can also install the node by referencing the name.
comfy node install <node-id>
The node id must be less than 50 characters and can only contain alphanumeric lowercase characters, hyphens, underscores, and periods. There should not be consecutive special characters and the id cannot start with a number or special character.
Version Number
The registry uses semantic versioning which indicates the specific release of a custom node through a three-digit version number X.Y.Z.
X - MAJOR change that breaks previous updates
Y - MINOR change that adds new features and is backwards compatible
Z - PATCH change that fixes a bug
License
An optional field that expects a relative path to your license file (usually named LICENSE
or LICENSE.txt
).
license = { file = "LICENSE" }
✅license = "LICENSE"
❌
Alternatively, it can also be referenced by name. Common licenses include MIT, GPL, or Apache.
license = {text = "MIT License"}
✅license = "MIT LICENSE"
❌
Read up more on toml file standards here
Publisher ID
The publisher id uniquely identifies a publisher and is ideally the same as your github username. It is also referred to as the username on the registry and can be found after the @
symbol on the profile page.
Icon
An optional field that expects a icon URL. It accepts extensions SVG, PNG, JPG or GIF with a maximum resolution of 800px by 400px.
Was this page helpful?