Griptape Nodes is a powerful, visual, node-based workflow builder designed for professional artists and creators. Build and execute complex AI workflows through the cloud-based Griptape Nodes IDE - an intuitive drag-and-drop interface.

This repository contains the Griptape Nodes Engine - the local component that runs securely on your machine, providing a performant foundation for workflow execution.

(Clicking the image opens the video on Vimeo)

✨ Key Features:

• 🎯 Visual Workflow Editor: Design and connect nodes representing different AI tasks, tools, and logic through the cloud-based IDE
• 🏠 Local Engine: Run workflows securely on your own machine or infrastructure
• 🐍 Portable Python Workflows: Workflows are saved as self-executable Python files for portability, debugability, and learning
• 🌐 Multi-Device Access: Client/server architecture lets you access your workflows from any device
• 🧩 Extensible: Build your own custom nodes and libraries to extend functionality
• ⚡ Scriptable Interface: Interact with and control flows programmatically

🔗 Learn More:

• 📚 Full Documentation: docs.griptapenodes.com
• ⚙️ Installation: docs.griptapenodes.com/en/stable/installation/
• 🔧 Engine Configuration: docs.griptapenodes.com/en/stable/configuration/
• 📋 Migration Guide: MIGRATION.md - Guide for migrating from deprecated nodes

🧩 Extending Griptape Nodes:

Want to create custom nodes for your specific workflow needs? Griptape Nodes is designed to be extensible through custom libraries:

• 📦 Custom Library Template: Get started with the Griptape Nodes Library Template
• 🛠️ Build Custom Nodes: Create specialized nodes tailored to your artistic and creative workflows

---

🚀 Quick Installation

Follow these steps to get the Griptape Nodes engine running on your system:

1. 🔐 Login: Visit Griptape Nodes and log in or sign up using your Griptape Cloud credentials.

2. 💾 Install Command: Once logged in, you'll find a setup screen. Copy the installation command provided in the "New Installation" section. It will look similar to this (use the exact command provided on the website):

   curl -LsSf https://raw.githubusercontent.com/griptape-ai/griptape-nodes/main/install.sh | bash

3. ⚡ Run Installer: Open a terminal on your machine (local or cloud environment) and paste/run the command. The installer uses uv for fast installation; if uv isn't present, the script will typically handle installing it.

4. ⚙️ Initial Configuration (Automatic on First Run):

   • The first time you run the engine command (griptape-nodes or gtn), it will guide you through the initial setup:
   • 📁 Workspace Directory: You'll be prompted to choose a directory where Griptape Nodes will store configurations, project files, secrets (.env), and generated assets. You can accept the default (<current_directory>/GriptapeNodes) or specify a custom path.
   • 🔑 Griptape Cloud API Key: Return to the Griptape Nodes setup page in your browser, click "Generate API Key", copy the key, and paste it when prompted in the terminal.

5. 🚀 Start the Engine: After configuration, start the engine by running:

   griptape-nodes

   (or the shorter alias gtn)

6. 🔗 Connect Workflow Editor: Refresh the Griptape Nodes Workflow Editor page in your browser. It should now connect to your running engine.

You're now ready to start building flows! 🎉 For more detailed setup options and troubleshooting, see the full Documentation.