How griptape-ai/griptape-nodes-library-nuke works
This library integrates Griptape workflows with Foundry Nuke through two main paths: running an annotated .nk script headlessly as a canvas node, and publishing a workflow as an installable, versioned .gizmo. The Annotator creates the sidecar that describes script ports; the headless path parses that metadata, builds a job manifest, launches Nuke, and returns artifacts. The publisher builds the gizmo and its bundled runner, with output and installation support. Some publisher and runner links are based on README claims or SOURCE INDEX references rather than complete excerpts.
Main entry points: nuke_script_node.py Nuke Script Node · nuke_gizmo_publisher.py Workflow publisher · runner.py Headless runner · direct.py Nuke subprocess
Components 27
Script execution
- Nuke Script Node
nuke_nodes/nuke_script_node.py - Script parser
script_parser/parser.py - Annotation sidecar
script_parser/sidecar.py - Annotation types
script_parser/annotation.py
Nuke plugin
- Griptape Annotator
nuke_plugin/griptape_annotator_panel.py - Nuke menu registration
nuke_plugin/menu_common.py - Flow-control nodes
nuke_nodes/nuke_start_flow.py - Workflow end node
nuke_nodes/nuke_end_flow.py
Gizmo publishing
- Workflow publisher
publish_gizmo/nuke_gizmo_publisher.py - Publish options
publish_gizmo/nuke_publish_options.py - Gizmo builder
publish_gizmo/nuke_gizmo_builder.py - Gizmo validator
publish_gizmo/gizmo_validator.py - Gizmo writer
publish_gizmo/gizmo_writer.py - Bundled workflow runner
publish_gizmo/nuke_workflow_runner.py - Output path handling
publish_gizmo/output_paths.py - Gizmo run button
publish_gizmo/run_button.py - Output protocol
publish_gizmo/output_protocol.py
Execution support
- Job manifest
nuke_runner/manifest.py - Nuke subprocess
execution/direct.py - Installation config
execution/installations.py - Nuke discovery
publish_gizmo/nuke_discovery.py - Headless runner
nuke_runner/runner.py - Script baker
nuke_runner/baker.py - Node introspection
nuke_runner/introspect.py
Other components
- Workflow author
- Foundry Nuke
- Nuke plugin directories
Connections 31
- Workflow author → Nuke Script Node: configures
README.md - Workflow author → Griptape Annotator: annotates
README.md - Griptape Annotator → Annotation sidecar: writes annotations
README.md - Nuke Script Node → Annotation sidecar: reads metadata
nuke_nodes/nuke_script_node.py - Nuke Script Node → Script parser: parses script
nuke_nodes/nuke_script_node.py - Nuke Script Node → Job manifest: builds job
nuke_nodes/nuke_script_node.py - Nuke Script Node → Nuke subprocess: launches Nuke
nuke_nodes/nuke_script_node.py - Nuke Script Node → Installation config: selects installation
nuke_nodes/nuke_script_node.py - Nuke subprocess → Job manifest: serializes job
execution/direct.py - Nuke subprocess → Headless runner: starts headless
README.md - Nuke subprocess → Installation config: builds command
execution/direct.py - Installation config → Nuke discovery: discovers executables
execution/installations.py - Headless runner → Job manifest: reads job
- Headless runner → Foundry Nuke: renders script
README.md - Headless runner → Script baker: bakes copy
- Headless runner → Node introspection: inspects nodes
- Foundry Nuke → Griptape Annotator: hosts panel
README.md - Nuke menu registration → Griptape Annotator: registers panel
nuke_plugin/menu_common.py - Workflow author → Workflow publisher: publishes workflow
README.md - Workflow publisher → Publish options: uses options
publish_gizmo/nuke_gizmo_publisher.py - Workflow publisher → Nuke discovery: finds targets
publish_gizmo/nuke_gizmo_publisher.py - Workflow publisher → Gizmo builder: builds gizmo
publish_gizmo/nuke_gizmo_publisher.py - Gizmo builder → Gizmo validator: validates gizmo
publish_gizmo/nuke_gizmo_builder.py - Gizmo validator → Gizmo writer: uses writer
publish_gizmo/gizmo_validator.py - Workflow publisher → Nuke plugin directories: installs bundle
README.md - Gizmo builder → Bundled workflow runner: bundles runner
README.md - Gizmo run button → Bundled workflow runner: invokes workflow
- Bundled workflow runner → Output path handling: resolves paths
publish_gizmo/nuke_workflow_runner.py - Bundled workflow runner → Output protocol: uses protocol
publish_gizmo/nuke_workflow_runner.py - Gizmo run button → Output protocol: uses protocol
publish_gizmo/run_button.py - Foundry Nuke → Gizmo run button: runs gizmo
README.md