Installation

Getting turnip up and running is straightforward. This guide will walk you through the installation process and verify your setup.

Prerequisites

Before installing turnip, ensure you have the following:

Node.js 18+

turnip requires Node.js version 18 or higher. Check your version with node --version

Solana Wallet

A funded Solana wallet with SOL for gas fees. You'll need the base58 private key for token deployment.

OpenAI API Key

API key from OpenAI with access to GPT Image models (gpt-image-1.5).

Helius API Key

Free API key from Helius for Solana RPC access.

Installation Methods

Method 1: NPM Install (Recommended)

Install turnip globally to run it from anywhere:

$ npm install -g turnip-agent

Or install locally in a project:

$ npm install turnip-agent

Method 2: Using NPX (No Installation)

Run turnip without installing it permanently:

$ npx turnip-agent

Tip: Using npx is great for trying turnip without committing to a global install, but global installation provides faster startup times.

Verify Installation

After installation, verify that turnip is correctly installed:

$ turnip --versionturnip-agent v1.0.0

Project Setup

Create a new directory for your turnip configuration:

$ mkdir my-turnip-project$ cd my-turnip-project$ touch .env

Your project structure should look like this:

my-turnip-project/
├── .env          # Your configuration file
└── output/       # Generated artwork (created automatically)

Troubleshooting

Permission Denied on macOS/Linux

If you encounter permission errors, install with sudo:

$ sudo npm install -g turnip-agent

Node Version Issues

If you're using an older Node version, upgrade using nvm:

$ nvm install 20$ nvm use 20

Package Not Found

If npm can't find the package, ensure you're using the correct registry:

$ npm config get registryhttps://registry.npmjs.org/