Skip to content

Griptape Nodes Command Line Interface (CLI)

If you're new to command-line interfaces (CLIs), a CLI is a text-based way to interact with software by typing commands instead of clicking buttons in a UI. Griptape Nodes provides a CLI with the the griptape-nodes (or gtn) command. This enables you to interact with Griptape Nodes in the terminal.

griptape-nodes (or its shorthand alias gtn) is a command-line tool specifically designed to launch and manage the Griptape Nodes Engine installation on your computer. This tool handles tasks like initializing your workspace, managing configuration settings, and starting the engine that powers the web-based Griptape Nodes editor. The actual creation and editing of workflows happens in the web interface that opens when you run the engine.

Basic Usage

griptape-nodes [options] [COMMAND]

If no command is specified, the tool defaults to the engine command.

Commands

engine (Default Command)

Run the Griptape Nodes engine.

griptape-nodes engine

This will start the Griptape Nodes engine and open the web interface at https://nodes.griptape.ai.

init

Initialize a new workspace for Griptape Nodes.

griptape-nodes init [options]

Options:

  • --api-key - Directly specify your Griptape API key without being prompted
  • --workspace-directory - Directly specify your workspace directory without being prompted

config

Manage your Griptape Nodes configuration.

griptape-nodes config SUBCOMMAND

Subcommands:

  • show - Show the current configuration settings
  • list - List all configuration files in order of precedence
  • reset - Reset your configuration to default values

self

Manage the CLI installation itself.

griptape-nodes self SUBCOMMAND

Subcommands:

  • uninstall - Uninstall the CLI, removing configuration and data directories
  • version - Display the current version of the CLI

libraries

Manage local libraries.

griptape-nodes libraries SUBCOMMAND

Subcommands:

  • sync - Sync libraries with your current engine version

Configuration

Griptape Nodes stores its configuration in the following locations:

  • Configuration directory: ~/.config/griptape_nodes (Linux/macOS) or %APPDATA%\griptape_nodes (Windows)
  • Data directory: ~/.local/share/griptape_nodes (Linux/macOS) or %LOCALAPPDATA%\griptape_nodes (Windows)
  • Configuration file: griptape_nodes_config.json in the configuration directory
  • Environment file: .env in the configuration directory

Workflow

Typical usage flow:

  1. Run griptape-nodes init to set up your workspace and API key
  2. Run griptape-nodes to start the engine
  3. Use the web interface to create and manage your workflows