Skip to main content

​
Overview

The pup init command initializes a new Pupload project in the current directory. This creates the necessary project structure and configuration files to get started with Pupload.

​
Usage

pup init <project-name>

​
Arguments

​
project-name
string
required
The name of the project to initialize. This will be used in project configuration and metadata.

​
Examples

​
Initialize a new project

pup init my-upload-project

​
Common workflow

# Create a new directory for your project
mkdir my-project
cd my-project

# Initialize the Pupload project
pup init my-project
The pup init command must be run from the directory where you want to create your project. It will initialize the project in the current working directory.

​
What gets created

When you run pup init, the following project structure is created:
  • Project configuration files
  • Default directory structure for flows and nodes
  • Example configuration templates
After initializing your project, you can start defining flows and nodes, then use pup dev to run a local development environment.
  • pup dev - Start a local development controller and worker
  • pup validate - Validate your project flows

Build docs developers (and LLMs) love

Get started for freeTalk to us